Skip to content

Commit 7a17266

Browse files
committed
Small tweaks to docs prior to release.
1 parent f404a0c commit 7a17266

File tree

4 files changed

+23
-2
lines changed

4 files changed

+23
-2
lines changed

docs/changes.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Change Log
88

99
* Nothing yet
1010

11-
2.3.7 (2020-06-12)
11+
2.3.7 (2020-06-13)
1212
~~~~~~~~~~~~~~~~~~~~~~~~~
1313

1414
* Documentation updates and deployment of pip wheels on tags (PR `#356`_).
@@ -35,6 +35,7 @@ Change Log
3535
.. _`#350`: https://github.com/hpc4cmb/toast/pull/350
3636
.. _`#352`: https://github.com/hpc4cmb/toast/pull/352
3737
.. _`#351`: https://github.com/hpc4cmb/toast/pull/351
38+
.. _`#348`: https://github.com/hpc4cmb/toast/pull/348
3839
.. _`#349`: https://github.com/hpc4cmb/toast/pull/349
3940
.. _`#341`: https://github.com/hpc4cmb/toast/pull/341
4041
.. _`#345`: https://github.com/hpc4cmb/toast/pull/345

docs/install.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ for that package <https://mpi4py.readthedocs.io/en/stable/install.html>`_. You
5353

5454
python -c 'import toast.tests; toast.tests.run()'
5555

56+
And test running in parallel with::
57+
58+
mpirun -np 2 python -c 'import toast.tests; toast.tests.run()'
59+
5660

5761
Conda Packages
5862
~~~~~~~~~~~~~~~~~~~~~~
@@ -144,6 +148,20 @@ and ``libsharp`` packages. For example::
144148

145149
conda install pysm3 libsharp
146150

151+
If you want to enable effective parallelism with toast, then you need to install the
152+
mpi4py package::
153+
154+
conda install mpi4py
155+
156+
As mentioned previously, you can test your TOAST installation by running the unit test
157+
suite::
158+
159+
python -c 'import toast.tests; toast.tests.run()'
160+
161+
And test running in parallel with::
162+
163+
mpirun -np 2 python -c 'import toast.tests; toast.tests.run()'
164+
147165

148166
Something Else
149167
~~~~~~~~~~~~~~~~~~~~~

docs/rtd_requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@ numpy
33
scipy
44
healpy
55
astropy
6+
h5py
7+
ephem

src/toast/RELEASE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2.3.7rc4
1+
2.3.7

0 commit comments

Comments
 (0)