Skip to content

Latest commit

 

History

History
176 lines (125 loc) · 6.42 KB

README.md

File metadata and controls

176 lines (125 loc) · 6.42 KB
Raw

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

Focal plane visualizer

We can visualize detectors in the focal plane by:

python -m litebird_sim.plot_fp

This software loads the IMo which is installed in the machine you are using. As the conversation unfolds, an interactive Matplotlib window will appear. Detectors corresponding to the specified channels are represented as blue dots. Clicking on a dot reveals the DetectorInfo for that detector in real time, highlighted with a red star. Additionally, if you agree during the conversation to generate a detector file, a list of starred detectors will be saved into a text file at the designated location after you closed the plot.

plot_fp_usage

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 - [email protected]

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

How to cite this code

TODO!