The Python Sky Model 3 software

The Python Sky Model 3 software - Published in JOSS (2021)

https://github.com/galsci/pysm

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 1 DOI reference(s) in JOSS metadata
  • Academic publication links
    Links to: arxiv.org, joss.theoj.org
  • Committers with academic emails
    3 of 14 committers (21.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

cosmic-microwave-background cosmology healpix healpy mpi python

Scientific Fields

Engineering Computer Science - 40% confidence
Last synced: 4 months ago · JSON representation ·

Repository

PySM 3: Sky emission simulations for Cosmic Microwave Background experiments

Basic Info
Statistics
  • Stars: 39
  • Watchers: 9
  • Forks: 29
  • Open Issues: 28
  • Releases: 15
Topics
cosmic-microwave-background cosmology healpix healpy mpi python
Created about 7 years ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Citation

README.rst

|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 `_

* `Full-sky Models of Galactic Microwave Emission and Polarization (Pan-Experiment Galactic Science Group, 2025) `_
* `The Python Sky Model 3 software (Zonca et al, 2021) `_
* `The Python Sky Model: software for simulating the Galactic microwave sky (Thorne et al, 2017) `_

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
* Make sure ``hatch`` detects the right version with ``hatch version``
* Build with ``hatch build``
* Upload to pypi with ``hatch publish``
* Upload to Github with ``git push --tags``

.. |CI Tests| image:: https://github.com/galsci/pysm/actions/workflows/ci_tests.yml/badge.svg
   :target: https://github.com/galsci/pysm/actions/workflows/ci_tests.yml
.. |Documentation Status| image:: https://readthedocs.org/projects/pysm3/badge/?version=latest
   :target: https://pysm3.readthedocs.io/en/latest/?badge=latest
.. |PyPI| image:: https://img.shields.io/pypi/v/pysm3
   :target: https://pypi.org/project/pysm3/
.. |Conda| image:: https://img.shields.io/conda/vn/conda-forge/pysm3
   :target: https://anaconda.org/conda-forge/pysm3
.. |Astropy| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
   :target: http://www.astropy.org/
.. |JOSS| image:: https://joss.theoj.org/papers/8f2d6c3bbf6cbeffbb403a1207fa8de7/status.svg
   :target: https://joss.theoj.org/papers/8f2d6c3bbf6cbeffbb403a1207fa8de7

Owner

  • Name: Pan-Experiment Galactic Science
  • Login: galsci
  • Kind: organization

JOSS Publication

The Python Sky Model 3 software
Published
November 01, 2021
Volume 6, Issue 67, Page 3783
Authors
Andrea Zonca ORCID
San Diego Supercomputer Center, University of California San Diego, San Diego, USA
Ben Thorne ORCID
Department of Physics, University of California Davis, One Shields Avenue, Davis, CA 95616, USA
Nicoletta Krachmalnicoff
SISSA, Via Bonomea 265, 34136 Trieste, Italy, INFN, Via Valerio 2, 34127 Trieste, Italy, IFPU, Via Beirut 2, 34014 Trieste, Italy
Julian Borrill
Computational Cosmology Center, Lawrence Berkeley National Laboratory, Berkeley, CA 94720, USA, Space Sciences Laboratory at University of California, 7 Gauss Way, Berkeley, CA 94720
Editor
Christina Hedges ORCID
Tags
cosmology astronomy python

Citation (CITATION)

@article{Panexp_2025,
      title={Full-sky Models of Galactic Microwave Emission and Polarization at Sub-arcminute Scales for the Python Sky Model}, 
      author={Pan-Experiment Galactic Science Group and Julian Borrill and Susan E. Clark and Jacques Delabrouille and Andrei V. Frolov and Shamik Ghosh and Brandon S. Hensley and Monica D. Hicks and Nicoletta Krachmalnicoff and King Lau and Myra M. Norton and Clement Pryke and Giuseppe Puglisi and Mathieu Remazeilles and Elisa Russier and Benjamin Thorne and Jian Yao and Andrea Zonca},
      year={2025},
      eprint={2502.20452},
      archivePrefix={arXiv},
      primaryClass={astro-ph.CO},
      url={https://arxiv.org/abs/2502.20452}, 
}

@article{Zonca_2021,
  doi = {10.21105/joss.03783},
  url = {https://doi.org/10.21105/joss.03783},
  year = {2021},
  publisher = {The Open Journal},
  volume = {6},
  number = {67},
  pages = {3783},
  author = {Andrea Zonca and Ben Thorne and Nicoletta Krachmalnicoff and Julian Borrill},
  title = {{The Python Sky Model 3 software}},
  journal = {Journal of Open Source Software}
}

@article{Thorne_2017,
   title={{The Python Sky Model: software for simulating the Galactic microwave sky}},
   volume={469},
   ISSN={1365-2966},
   url={http://dx.doi.org/10.1093/mnras/stx949},
   DOI={10.1093/mnras/stx949},
   number={3},
   journal={Monthly Notices of the Royal Astronomical Society},
   publisher={Oxford University Press (OUP)},
   author={Thorne, B. and Dunkley, J. and Alonso, D. and Næss, S.},
   year={2017},
   month={May},
   pages={2821–2833}
}

GitHub Events

Total
  • Create event: 10
  • Release event: 1
  • Issues event: 30
  • Watch event: 4
  • Delete event: 6
  • Issue comment event: 138
  • Push event: 47
  • Pull request review event: 13
  • Pull request review comment event: 11
  • Pull request event: 35
  • Fork event: 7
Last Year
  • Create event: 10
  • Release event: 1
  • Issues event: 30
  • Watch event: 4
  • Delete event: 6
  • Issue comment event: 138
  • Push event: 47
  • Pull request review event: 13
  • Pull request review comment event: 11
  • Pull request event: 35
  • Fork event: 7

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 1,096
  • Total Committers: 14
  • Avg Commits per committer: 78.286
  • Development Distribution Score (DDS): 0.06
Past Year
  • Commits: 153
  • Committers: 4
  • Avg Commits per committer: 38.25
  • Development Distribution Score (DDS): 0.039
Top Committers
Name Email Commits
Andrea Zonca c****e@a****m 1,030
Ben Thorne b****e@g****m 23
ben thorne b****e@p****k 17
Zack Li x****i@g****m 6
Xavier Garrido x****o@g****m 4
Mathew Madhavacheril m****c@g****m 3
Miguel Ruiz-Granda 9****a 3
brandonshensley b****y@g****m 2
NicolettaK n****h@s****t 2
JamesAmato 1****o 2
Simon Biquard s****t@g****m 1
Jian Yao y****5@o****m 1
Giuseppe Puglisi g****i@b****u 1
Daniel S. Katz d****z@i****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 79
  • Total pull requests: 107
  • Average time to close issues: 6 months
  • Average time to close pull requests: about 1 month
  • Total issue authors: 26
  • Total pull request authors: 11
  • Average comments per issue: 6.91
  • Average comments per pull request: 3.35
  • Merged pull requests: 78
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 16
  • Pull requests: 37
  • Average time to close issues: 20 days
  • Average time to close pull requests: 11 days
  • Issue authors: 9
  • Pull request authors: 4
  • Average comments per issue: 2.5
  • Average comments per pull request: 1.22
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • zonca (34)
  • brandonshensley (6)
  • erussier (6)
  • giuspugl (5)
  • NicolettaK (3)
  • 1cosmologist (2)
  • msyriac (2)
  • JamesAmato (2)
  • yaojian95 (2)
  • LeoVacher (1)
  • edelahoz (1)
  • casasjm (1)
  • pllim (1)
  • sbiquard (1)
  • marcelo-alvarez (1)
Pull Request Authors
  • zonca (84)
  • giuspugl (4)
  • msyriac (4)
  • JamesAmato (4)
  • kmsurrao (2)
  • xzackli (2)
  • miguelrgranda (2)
  • sbiquard (2)
  • bthorne93 (1)
  • YJHelloWorld (1)
  • danielskatz (1)
Top Labels
Issue Labels
help wanted (1) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 688 last-month
  • Total dependent packages: 2
  • Total dependent repositories: 9
  • Total versions: 25
  • Total maintainers: 2
pypi.org: pysm3

PySM generates full-sky simulations of Galactic emissions in intensity and polarization

  • Homepage: https://github.com/galsci/pysm
  • Documentation: https://pysm3.readthedocs.io/
  • License: Copyright 2021 Andrea Zonca Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  • Latest release: 3.4.2
    published 6 months ago
  • Versions: 25
  • Dependent Packages: 2
  • Dependent Repositories: 9
  • Downloads: 688 Last month
Rankings
Dependent packages count: 3.2%
Dependent repos count: 4.8%
Average: 6.1%
Downloads: 10.1%
Last synced: 4 months ago

Dependencies

docs/requirements.txt pypi
  • astropy *
  • healpy *
  • ipykernel *
  • nbsphinx *
  • numba *
  • numpy *
  • pandoc *
  • sphinx-astropy *
  • sphinx-math-dollar *
  • toml *
.github/workflows/ci_tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/paper.yaml actions
  • actions/checkout v2 composite
  • actions/upload-artifact v1 composite
  • docker://openjournals/paperdraft latest composite