Skip to main content

s(t) emulation of smooth functions by stacking

Project description

stemu:

s(t) emulation of smooth functions by stacking

Author:

Harry Bevins & Will Handley

Version:
0.0.1
Homepage:

https://github.com/handley-lab/stemu

Documentation:

http://stemu.readthedocs.io/

Unit test status Build status Test Coverage Status Documentation Status PyPi location Conda location Permanent DOI for this release License information

A repository for emulation of smooth functions by stacking

UNDER CONSTRUCTION

Features

Installation

stemu can be installed via pip

pip install stemu

via conda

conda install -c handley-lab stemu

or via the github repository

git clone https://github.com/handley-lab/stemu
cd stemu
python -m pip install .

You can check that things are working by running the test suite:

python -m pytest
black .
isort --profile black .
pydocstyle --convention=numpy stemu

Dependencies

Basic requirements:

Documentation:

Tests:

Documentation

Full Documentation is hosted at ReadTheDocs. To build your own local copy of the documentation you’ll need to install sphinx. You can then run:

python -m pip install ".[all,docs]"
cd docs
make html

and view the documentation by opening docs/build/html/index.html in a browser. To regenerate the automatic RST files run:

sphinx-apidoc -fM -t docs/templates/ -o docs/source/ stemu/

Citation

If you use stemu to generate results for a publication, please cite as:

H.T.J. Bevins, W.J. Handley, A. Fialkov, E. de Lera Acedo, K. Javid. globalemu: a novel and robust approach for emulating the sky-averaged 21-cm signal from the cosmic dawn and epoch of reionization, DOI: 10.1093/mnras/stab2737, Mon.Not.Roy.Astron.Soc. 508 (2021) 2, 2923-2936

or using the BibTeX:

@article{Bevins:2021eah,
        author = "Bevins, H. T. J. and Handley, W. J. and Fialkov, A. and Acedo, E. de Lera and Javid, K.",
        title = "{globalemu: a novel and robust approach for emulating the sky-averaged 21-cm signal from the cosmic dawn and epoch of reionization}",
        eprint = "2104.04336",
        archivePrefix = "arXiv",
        primaryClass = "astro-ph.CO",
        doi = "10.1093/mnras/stab2737",
        journal = "Mon. Not. Roy. Astron. Soc.",
        volume = "508",
        number = "2",
        pages = "2923--2936",
        year = "2021"
}

Contributing

There are many ways you can contribute via the GitHub repository.

  • You can open an issue to report bugs or to propose new features.

  • Pull requests are very welcome. Note that if you are going to propose major changes, be sure to open an issue for discussion first, to make sure that your PR will be accepted before you spend effort coding it.

  • Adding models and data to the grid. Contact Will Handley to request models or ask for your own to be uploaded.

Questions/Comments

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stemu-0.0.1.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

stemu-0.0.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file stemu-0.0.1.tar.gz.

File metadata

  • Download URL: stemu-0.0.1.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for stemu-0.0.1.tar.gz
Algorithm Hash digest
SHA256 1fb91b258b54d330e0d55e92c00408270ea2ae56509c0de6a86d93d5a2575db3
MD5 6b860b08131b8f1bb636b654c6a68a9e
BLAKE2b-256 b959371639ea31a184e2d25b2e407b25b39419299b392067fa72b96f1e5e1a53

See more details on using hashes here.

File details

Details for the file stemu-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: stemu-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for stemu-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d90f4aba3c243b17b6985e63df9acffb0a47a5c406504139f6b5ceaa8645ead4
MD5 d84526dd1170e82e4f5d4618162ad271
BLAKE2b-256 805acd18a4a90e671f5c538bd970fbfe3eda17c38188c3f16956bc331a518231

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page