Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 2.57 KB

README.rst

File metadata and controls

60 lines (45 loc) · 2.57 KB

CI Tests Documentation Status PyPI Conda Astropy JOSS

PySM 3

PySM generates full-sky simulations of Galactic emissions in intensity and polarization relevant to CMB experiments. It is a large refactor of PySM 2 focused on reducing memory usage, improving performance and run in parallel with MPI.

See the documentation at https://pysm3.readthedocs.io

See changes in CHANGES.rst in the repository.

Related scientific papers

See CITATION

Install

See the documentation

  • Install with pip install . or with pip install .[test] to also install the requirements for running tests
  • Optionally, if you have an MPI environment available and you would like to test the MPI capabilities of PySM, install mpi4py and libsharp, check the documentation link above for more details.
  • Check code style with tox -e codestyle
  • Test with pytest or tox -e test
  • Building docs requires pandoc, not the python package, the actual pandoc command line tool, install it with conda or your package manager
  • Build docs locally with tox -e build_docs

Support

For any question or issue with the software open an issue.

Release

  • Tag the new version with git
  • pip install build --upgrade
  • python -m build --sdist --wheel .
  • twine upload dist/*