Metadata-Version: 2.1
Name: litebird-sim
Version: 0.9.0
Summary: Simulation tools for the LiteBIRD experiment
License: GPL3
Author: The LiteBIRD Simulation Team
Requires-Python: >=3.7.1,<3.10
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: jupyter
Provides-Extra: mpi
Requires-Dist: PyGithub (>=1.53,<2.0)
Requires-Dist: asciimatics (>=1.12.0,<2.0.0)
Requires-Dist: astropy (>=4.3,<5.0)
Requires-Dist: black (>=22.3,<23.0)
Requires-Dist: deprecation (>=2.1.0,<3.0.0)
Requires-Dist: ducc0 (>=0.25.0,<0.26.0)
Requires-Dist: flake8 (>=3.7,<4.0)
Requires-Dist: h5py (==3.4)
Requires-Dist: healpy (>=1.15.0,<2.0.0)
Requires-Dist: jinja2 (>=3.0,<4.0)
Requires-Dist: jplephem (>=2.14,<3.0)
Requires-Dist: jupyter (>=1.0,<2.0) ; extra == "jupyter"
Requires-Dist: jupyterlab (>=1.2,<2.0)
Requires-Dist: katex (>=0.0.4,<0.0.5)
Requires-Dist: markdown (>=3.2,<4.0)
Requires-Dist: markdown-katex (>=202006.1021,<202007.0)
Requires-Dist: matplotlib (>=3.1,<4.0)
Requires-Dist: mpi4py (>=3.0,<4.0) ; extra == "mpi"
Requires-Dist: numba (>=0.55,<0.56)
Requires-Dist: numpy (>=1.21,<2.0)
Requires-Dist: pre-commit (>=2.15.0,<3.0.0)
Requires-Dist: pybind11 (>=2.5.0,<3.0.0)
Requires-Dist: pyperclip (>=1.8.1,<2.0.0)
Requires-Dist: pysm3 (>=3.3.0,<4.0.0)
Requires-Dist: pytest (>=5.3,<6.0)
Requires-Dist: pyyaml (>=5.3.1,<6.0.0)
Requires-Dist: requests (>=2.24.0,<3.0.0)
Requires-Dist: rich (>=11.0.0,<12.0.0)
Requires-Dist: sphinx (>=5.1,<6.0)
Requires-Dist: sphinx_rtd_theme (>=1.0.0,<2.0.0)
Requires-Dist: sphinxcontrib-bibtex (>=2.5.0,<3.0.0)
Requires-Dist: sphinxcontrib-contentui (>=0.2.5,<0.3.0)
Requires-Dist: sphinxcontrib.asciinema (>=0.3.4,<0.4.0)
Requires-Dist: toast-cmb (>=2.3.14,<3.0.0)
Requires-Dist: tomlkit (>=0.11.2,<0.12.0)
Description-Content-Type: text/markdown

<!--
Template taken from https://github.com/othneildrew/Best-README-Template

*** To avoid retyping too much info. Do a search and replace for the following:
*** github_username, repo, twitter_handle, email
-->


<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://litebird-sim.readthedocs.io/en/master/)
[![Tests](https://github.com/litebird/litebird_sim/workflows/Tests/badge.svg?branch=master&event=push)](https://github.com/litebird/litebird_sim/actions?query=workflow%3ATests+branch%3Amaster)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/litebird/litebird-sim?svg=true)](https://ci.appveyor.com/project/litebird/litebird-sim)
[![Issues][issues-shield]][issues-url]
[![GPL3 License][license-shield]][license-url]


<!-- PROJECT LOGO -->
<br />
<p align="center">
  <a href="https://github.com/litebird/litebird_sim">
    <img src="images/logo.png" alt="Logo" width="80" height="80">
  </a>

  <h3 align="center">LiteBIRD Simulation Framework</h3>

  <p align="center">
    Main repository of the LiteBIRD Simulation Framework, a set of Python modules to simulate the instruments onboard the LiteBIRD spacecraft.
    <br />
    <a href="https://litebird-sim.readthedocs.io/en/master/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://litebird-sim.readthedocs.io/en/master/tutorial.html">View Demo</a>
    ·
    <a href="https://github.com/litebird/litebird_sim/issues">Report Bug</a>
    ·
    <a href="https://github.com/litebird/litebird_sim/issues">Request Feature</a>
  </p>
</p>



<!-- TABLE OF CONTENTS -->
## Table of Contents

* [About the Project](#about-the-project)
  * [Built With](#built-with)
* [Getting Started](#getting-started)
  * [Prerequisites](#prerequisites)
  * [Installation](#installation)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)



<!-- ABOUT THE PROJECT -->
## About The Project

The LiteBIRD Simulation Framework is being developed for the
[LiteBIRD collaboration](http://litebird.jp/eng/).


### Built With

-   Love!
-   [Python 3](https://www.python.org)
-   [Poetry](https://python-poetry.org/)
-   [NumPy](https://numpy.org)
-   [Astropy](https://www.astropy.org)
-   [Healpix](https://healpix.jpl.nasa.gov)
-   [Sphinx](https://www.sphinx-doc.org/en/master/)
-   [Numba](https://numba.pydata.org/)
-   [ducc](https://github.com/litebird/ducc)


<!-- GETTING STARTED -->
## Getting Started

Refer to the
[documentation](https://litebird-sim.readthedocs.io/en/master/installation.html)
to learn how to install the LiteBIRD simulation framework on your
computer or on a HPC cluster.


<!-- USAGE EXAMPLES -->
## Usage

An example notebook is avalable [here](https://github.com/litebird/litebird_sim/blob/master/notebooks/litebird_sim_example.ipynb). 

The documentation is available online at
[litebird-sim.readthedocs.io/en/master/](https://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 -->
## Roadmap

See the [open issues](https://github.com/litebird/litebird_sim/issues)
for a list of proposed features (and known issues).


<!-- CONTRIBUTING -->
## 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](https://github.com/litebird/litebird_sim/blob/master/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 -->
## License

Distributed under the [GPL3 License][license-url].


<!-- CONTACT -->
## Contact

LiteBIRD Simulation Team - litebird_pipe@db.ipmu.jp

Project Link: [https://github.com/litebird/litebird_sim](https://github.com/litebird/litebird_sim)



<!-- ACKNOWLEDGEMENTS -->
## How to cite this code

TODO!


<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[issues-shield]: https://img.shields.io/github/issues/litebird/litebird_sim?style=flat-square
[issues-url]: https://github.com/litebird/litebird_sim/issues
[license-shield]: https://img.shields.io/github/license/litebird/litebird_sim.svg?style=flat-square
[license-url]: https://github.com/litebird/litebird_sim/blob/master/LICENSE

<!-- Once we have some nice screenshot, let's put a link to it here! -->
[product-screenshot]: images/screenshot.png

