Skip to content

Commit 3eda774

Browse files
authored
updating docs with test info (#273)
1 parent 652bc79 commit 3eda774

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

docs/install.rst

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ This will install the latest stable release of Charm4Py, using the default under
2828
use a specific Charm++ build, you can install and build Charm4Py from source. Note that the source distribution
2929
is available via "pip install", but the standard from source build process is via "git clone", as outlined below.
3030

31+
To minimally test the pip installation, you can run the following one-line example::
32+
33+
$ python -c 'import charm4py; charm4py.charm.start(lambda x: print("hello") or charm4py.charm.exit())'
34+
35+
To run the full test suite, it is necessary to build Charm4Py from source. Examples of charm4py programs are also available in the Charm4Py source.
36+
3137
Installing Charm4Py from source
3238
------------------------------------------------------------
3339

@@ -60,14 +66,16 @@ the charm directory and run the following build command, then build Charm4Py::
6066
Finally, if necessary, when installing dependencies or when running the install script, add the --user
6167
option to the Python command to complete the installation without permission errors.
6268

63-
After building, you can run Charm4py examples. One example you can try is
64-
array_hello.py, which can be run as follows::
69+
After building, you can run Charm4py examples. For example::
6570

66-
$ cd examples/hello
67-
$ python -m charmrun.start +p2 array_hello.py
71+
$ python -m charmrun.start +p2 examples/hello/array_hello.py
6872

69-
Choosing your target architecture when building from source
70-
------------------------------------------------------------
73+
The full charm4py test suite can be run from the Charm4Py root as follows::
74+
75+
$ python auto_test.py
76+
77+
Choosing the target architecture
78+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7179

7280
When building from source, as described above, you must chose the appropriate target architecture.
7381

0 commit comments

Comments
 (0)