Skip to main content

Simulation tools for the LiteBIRD experiment

Project description

Stable Tests Build Status Issues GPL3 License


Logo

LiteBIRD Simulation Framework

Main repository of the LiteBIRD Simulation Framework, a set of Python modules to simulate the instruments onboard the LiteBIRD spacecraft.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

The LiteBIRD Simulation Framework is being developed for the LiteBIRD collaboration.

Built With

Getting Started

Refer to the documentation to learn how to install the LiteBIRD simulation framework on your computer or on a HPC cluster.

Usage

An example notebook is avalable here.

The documentation is available online at litebird-sim.readthedocs.io/en/master/.

To create a local copy of the documentation, make sure you ran poetry with the flag --extras=docs, then run the following command:

  • Linux or Mac OS X:

    ./refresh_docs.sh
    
  • Windows:

    poetry shell
    cd docs
    make.bat html
    

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

If you are part of the LiteBIRD collaboration and have something that might fit in this framework, you're encouraged to contact us! Any contributions you make are greatly appreciated.

  1. Read CONTRIBUTING.md
  2. Fork the project
  3. Create your feature branch (git checkout -b feature/AmazingFeature)
  4. Commit your changes (git commit -m 'Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull Request

License

Distributed under the GPL3 License.

Contact

LiteBIRD Simulation Team - litebird_pipe@db.ipmu.jp

Project Link: https://github.com/litebird/litebird_sim

How to cite this code

TODO!

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

litebird_sim-0.13.0.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

litebird_sim-0.13.0-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

Details for the file litebird_sim-0.13.0.tar.gz.

File metadata

  • Download URL: litebird_sim-0.13.0.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.4 Linux/6.6.32-1-MANJARO

File hashes

Hashes for litebird_sim-0.13.0.tar.gz
Algorithm Hash digest
SHA256 0785db1169580f9aeb390505fb9383a7746eac0d3188e37815cf95dd9c4cadcc
MD5 058085612e9bb15445f917ac8c7f578a
BLAKE2b-256 71a58815852f7385798e4d414aa85623f3905e0b2ffd1e9d164345f9bcea71ef

See more details on using hashes here.

File details

Details for the file litebird_sim-0.13.0-py3-none-any.whl.

File metadata

  • Download URL: litebird_sim-0.13.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.11.4 Linux/6.6.32-1-MANJARO

File hashes

Hashes for litebird_sim-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 78c7e534188deb4d4b632a8abb70b0e9f45d5c0b27e4874472b4652b94838996
MD5 33f4da8606310844e1102db0fb667816
BLAKE2b-256 8bfcd12beaa1e1ae89f5f6ba96f31d03af535808230ab5547b6ec77dfa05c7d7

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