Metadata-Version: 2.4
Name: darkflipper
Version: 0.0.4
Summary: Dark Energy Figure of Merit and Figure of Bias for Likelihood Pipelines
Author-email: Guadalupe Cañas Herrera <canasherrera@strw.leidenuniv.nl>
License: MIT License
        
        Copyright (c) 2025 cloe-org/cloelib
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
License-File: LICENSE
Keywords: Bayesian inference,Euclid,cosmology,dark energy
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: getdist
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: shapely
Description-Content-Type: text/markdown

<p align="center">
  <img src="docs/darkflipper-logo-white.png" alt="darkflipper logo" width="400">
</p>

**Flip the dark side of statistics in cosmology.**
Figures of Merit, Bias, and statistical diagnostics such as p-values and much more.

---

## 🐬 What is _darkflipper_?

`darkflipper` is a lightweight Python package delivering **essential statistical tools for cosmology** at ease:

It’s designed for scientists who:

- are investigating systematics in cosmological data
- care about **Figures of Merit** _and_ **Figures of Bias** in cosmological inference
- want results that are robust, transparent, and publication-ready without worrying about definitions

---

## 📦 Installation

One command.

```sh
pip install darkflipper
```

---

## 🧩 Requirements

`darkflipper` plays nicely with the standard packages:

- Python ≥ 3.8
- `numpy`
- `scipy`
- `matplotlib`
- `getdist`
- `shapely`

---

## 🤝 Contributing

Want to help shape the dark side? We’d love to have you.

1. **Open an issue** to discuss your idea — new feature, new statistics, or all-dreamy thought
2. **Create a feature branch**
   ```sh
   git checkout -b feature/your-feature-name
   ```
3. **Commit your work**
   ```sh
   git commit -m "Add awesome feature"
   ```
4. **Push it**
   ```sh
   git push origin feature/your-feature-name
   ```
5. **Open a pull request** and let’s flip it together ✨

## 🤝 Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tbody>
    <tr>
      <td align="center" valign="top" width="14.28%"><a href="http://jclaramunt.github.io"><img src="https://avatars.githubusercontent.com/u/32998547?v=4?s=100" width="100px;" alt="Juan Claramunt"/><br /><sub><b>Juan Claramunt</b></sub></a><br /><a href="#ideas-jclaramunt" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-jclaramunt" title="Reviewed Pull Requests">👀</a></td>
      <td align="center" valign="top" width="14.28%"><a href="http://gcanasherrera.com"><img src="https://avatars.githubusercontent.com/u/13239454?v=4?s=100" width="100px;" alt="Guadalupe Cañas-Herrera"/><br /><sub><b>Guadalupe Cañas-Herrera</b></sub></a><br /><a href="#code-gcanasherrera" title="Code">💻</a> <a href="#bug-gcanasherrera" title="Bug reports">🐛</a> <a href="#doc-gcanasherrera" title="Documentation">📖</a></td>
      <td align="center" valign="top" width="14.28%"><a href="http://www.santicasas.xyz"><img src="https://avatars.githubusercontent.com/u/6987716?v=4?s=100" width="100px;" alt="Santiago Casas"/><br /><sub><b>Santiago Casas</b></sub></a><br /><a href="#ideas-santiagocasas" title="Ideas, Planning, & Feedback">🤔</a> <a href="#code-santiagocasas" title="Code">💻</a></td>
    </tr>
  </tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
