euclidlib is an unofficial Python library for accessing and reading cosmology-ready data products from the ESA Euclid mission. Its goal is to offer the Euclid community a user-friendly, ready-to-use library that enables immediate work with science-ready Euclid data.
The package is maintained on a best-effort basis by volunteers and contributors within the Euclid community. See the contributor list below.
As simple as:
pip install euclidlibpython>3.7fitsionumpy
The design of the euclidlib package closely follows the organisation of the Euclid Data Product Description Documentation and reflects the structure of the Euclid Science Ground Segment.
graph TD
EUCLIDLIB[euclidlib]
LE3[le3]
PK_WL[pk_wl]
TWOPCF_WL[twopcf_wl]
PK_GC[pk_gc]
TWOPCF_GC[twopcf_gc]
BAO_GC[bao_gc]
PHZ[phz]
EUCLIDLIB --> LE3
EUCLIDLIB --> PHZ
LE3 --> PK_WL
LE3 --> TWOPCF_WL
LE3 --> PK_GC
LE3 --> TWOPCF_GC
LE3 --> BAO_GC
euclidlib provides all data products in a unified, Pythonic format based on dataclasses, ensuring consistent, intuitive, and easy-to-use interfaces across all supported products. Please consult the full documentation for additional details.
If you would like to contribute, follow the following steps:
- Open an issue to let the
euclidlibmaintainers know about your contribution plans (new Euclid product? New feature? A suggestion?) - Create a new branch:
git checkout -b feature/your-feature-name
- Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin feature/your-feature-name
- Open a pull request
This project is licensed under the MIT License - see the LICENSE file for details.
This project follows the all-contributors specification. Contributions of any kind are welcome!
To discover the meaning of each icon, hover your mouse over it.