Skip to content

Commit

Permalink
Small tweaks to docs prior to release.
Browse files Browse the repository at this point in the history
  • Loading branch information
tskisner committed Jun 13, 2020
1 parent f404a0c commit 7a17266
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Change Log

* Nothing yet

2.3.7 (2020-06-12)
2.3.7 (2020-06-13)
~~~~~~~~~~~~~~~~~~~~~~~~~

* Documentation updates and deployment of pip wheels on tags (PR `#356`_).
Expand All @@ -35,6 +35,7 @@ Change Log
.. _`#350`: https://github.com/hpc4cmb/toast/pull/350
.. _`#352`: https://github.com/hpc4cmb/toast/pull/352
.. _`#351`: https://github.com/hpc4cmb/toast/pull/351
.. _`#348`: https://github.com/hpc4cmb/toast/pull/348
.. _`#349`: https://github.com/hpc4cmb/toast/pull/349
.. _`#341`: https://github.com/hpc4cmb/toast/pull/341
.. _`#345`: https://github.com/hpc4cmb/toast/pull/345
Expand Down
18 changes: 18 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ for that package <https://mpi4py.readthedocs.io/en/stable/install.html>`_. You

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

And test running in parallel with::

mpirun -np 2 python -c 'import toast.tests; toast.tests.run()'


Conda Packages
~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -144,6 +148,20 @@ and ``libsharp`` packages. For example::

conda install pysm3 libsharp

If you want to enable effective parallelism with toast, then you need to install the
mpi4py package::

conda install mpi4py

As mentioned previously, you can test your TOAST installation by running the unit test
suite::

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

And test running in parallel with::

mpirun -np 2 python -c 'import toast.tests; toast.tests.run()'


Something Else
~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 2 additions & 0 deletions docs/rtd_requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ numpy
scipy
healpy
astropy
h5py
ephem
2 changes: 1 addition & 1 deletion src/toast/RELEASE
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.3.7rc4
2.3.7

0 comments on commit 7a17266

Please sign in to comment.