https://github.com/euclidlib/euclidlib

Unofficial python library for reading cosmology-ready data products from the ESA Euclid mission
https://github.com/euclidlib/euclidlib

cosmology euclid library python

Last synced: 5 months ago
JSON representation

Unofficial python library for reading cosmology-ready data products from the ESA Euclid mission

• Host: GitHub
• URL: https://github.com/euclidlib/euclidlib
• Owner: euclidlib
• License: mit
• Created: 2024-02-15T17:20:08.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2026-01-12T19:53:42.000Z (5 months ago)
• Last Synced: 2026-01-13T00:48:42.681Z (5 months ago)
• Topics: cosmology, euclid, library, python
• Language: Python
• Homepage: https://euclidlib.readthedocs.io
• Size: 98.3 MB
• Stars: 12
• Watchers: 4
• Forks: 1
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# euclidlib

[![PyPI version](https://img.shields.io/pypi/v/euclidlib.svg)](https://pypi.org/project/euclidlib/)

[![CI](https://github.com/euclidlib/euclidlib/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/euclidlib/euclidlib/actions/workflows/tests.yml)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)

[![Tests: pytest](https://img.shields.io/badge/tests-pytest-blue?logo=pytest)](https://docs.pytest.org/)

[![Linting: Ruff](https://img.shields.io/badge/linting-ruff-purple?logo=ruff&logoColor=white)](https://docs.astral.sh/ruff/)

[![Code Style: Prettier](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg?logo=prettier&logoColor=white)](https://prettier.io/)

[![Type Checking: mypy](https://img.shields.io/badge/type%20checking-mypy-8A2BE2?logo=mypy&logoColor=white)](https://mypy.readthedocs.io/)

[![All Contributors](https://img.shields.io/github/all-contributors/euclidlib/euclidlib?color=ee8449&style=flat-square)](#contributors)

## Table of Contents

- [Introduction](#introduction)

- [Installation](#installation)

- [Contributing](#contributing)

- [License](#license)

- [Contributors](#contributors)

## Introduction

`euclidlib` is an unofficial Python package designed to access official Euclid mission products provided by the Science Ground Segment. 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.

## Installation

As simple as:

```sh

pip install euclidlib

```

### Prerequisites

- `python>3.7`

- `fitsio`

- `numpy`

## Structure and Format of `euclidlib`

The design of the `euclidlib` package closely follows the organisation of the [Euclid Data Product Description Documentation](http://st-dm.pages.euclid-sgs.uk/data-product-doc/dm10/) and reflects the structure of the Euclid Science Ground Segment.

```mermaid

graph TD

    EUCLIDLIB[euclidlib]

    LE3[le3]

    PK[pk_wl]

    TWOPCF[twopcf_wl]

    PHZ[phz]

    EUCLIDLIB --> LE3

    EUCLIDLIB --> PHZ

    LE3 --> PK

    LE3 --> TWOPCF

```

`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.

## Contributing

If you would like to contribute, follow the following steps:

1. Open an issue to let the `euclidlib` maintainers know about your contribution plans (new Euclid product? New feature? A suggestion?)

2. Create a new branch:

   ```sh

   git checkout -b feature/your-feature-name

   ```

3. Commit your changes:

   ```sh

   git commit -m 'Add some feature'

   ```

4. Push to the branch:

   ```sh

   git push origin feature/your-feature-name

   ```

5. Open a pull request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contributors

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

To discover the meaning of each icon, hover your mouse over it.

  

    

      
Guadalupe Cañas-Herrera
💻 👀 🤔 🚧 ⚠️ 💡

      
Nicolas Tessore
💻 👀 🤔 💡 🚧 ⚠️

      
Zahra Baghkhani
💻

      
Jaime RZ
👀 🤔

      
itutusaus
👀

      
Felicitas Keil
💻

      
WillHartley
🤔 🔣

    

    

      
FlorianDubath
🤔 🔣

      
Jacopo Salvalaggio
💻 🤔 🔣