Skip to content

Commit 2d1d409

Browse files
committed
Add README badges, demo GIF, CITATION.cff, and Euclid disclaimer
- Add PyPI, DOI, license, and Python version badges - Add demo GIF to showcase UI - Add pip install instructions - Add note about Euclid Q1/IDR1 data optimisation - Create CITATION.cff for proper academic citation
1 parent e2e9c2b commit 2d1d409

File tree

4 files changed

+66
-0
lines changed

4 files changed

+66
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,3 +232,4 @@ job_tracking.json
232232
cutana_output/
233233
test_workflow_*
234234
examples/*.csv
235+
demo

CITATION.cff

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
title: "Cutana: A High-Performance Tool for Astronomical Image Cutout Generation at Petabyte Scale"
4+
type: software
5+
authors:
6+
- family-names: "Gómez"
7+
given-names: "Pablo"
8+
- family-names: "Ruhberg"
9+
given-names: "Laslo Erik"
10+
- family-names: "Remmelgas"
11+
given-names: "Kristin Anett"
12+
- family-names: "O'Ryan"
13+
given-names: "David"
14+
version: "0.1.2"
15+
date-released: 2025-11-28
16+
url: "https://github.com/ESA/Cutana"
17+
repository-code: "https://github.com/ESA/Cutana"
18+
license: "ESA-PL-Permissive-v2.4"
19+
keywords:
20+
- astronomy
21+
- image processing
22+
- cutouts
23+
- FITS
24+
- Euclid
25+
- ESA
26+
preferred-citation:
27+
type: article
28+
authors:
29+
- family-names: "Gómez"
30+
given-names: "Pablo"
31+
- family-names: "Ruhberg"
32+
given-names: "Laslo Erik"
33+
- family-names: "Remmelgas"
34+
given-names: "Kristin Anett"
35+
- family-names: "O'Ryan"
36+
given-names: "David"
37+
title: "Cutana: A High-Performance Tool for Astronomical Image Cutout Generation at Petabyte Scale"
38+
year: 2025
39+
identifiers:
40+
- type: doi
41+
value: "10.48550/arXiv.2511.04429"
42+
- type: other
43+
value: "arXiv:2511.04429"
44+
description: "arXiv preprint"
45+
url: "https://arxiv.org/abs/2511.04429"

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,35 @@
66
[//]: # (the terms contained in the file 'LICENCE.txt'.)
77
# Cutana - Astronomical Cutout Pipeline
88

9+
[![PyPI version](https://img.shields.io/pypi/v/cutana.svg)](https://pypi.org/project/cutana/)
10+
[![PyPI downloads](https://img.shields.io/pypi/dm/cutana.svg)](https://pypi.org/project/cutana/)
11+
[![DOI](https://img.shields.io/badge/DOI-10.48550/arXiv.2511.04429-blue)](https://doi.org/10.48550/arXiv.2511.04429)
12+
[![License](https://img.shields.io/badge/License-ESA--PL%20Permissive-green)](LICENSE.txt)
13+
[![Python](https://img.shields.io/pypi/pyversions/cutana.svg)](https://pypi.org/project/cutana/)
14+
915
**Cutana** is a high-performance Python pipeline for creating astronomical image cutouts from large FITS datasets. It provides both an interactive **Jupyter-based UI** and a **programmatic API** for efficient processing of astronomical survey data like ESA Euclid observations.
1016

17+
![Cutana Demo](assets/cutana_demo_2x.gif)
18+
19+
> **Note:** Cutana is currently optimised for **Euclid Q1/IDR1 data**. Some defaults and assumptions are Euclid-specific:
20+
> - Flux conversion expects the `MAGZERO` header keyword (configurable via `config.flux_conversion_keywords.AB_zeropoint`)
21+
> - Filter detection patterns are tuned for Euclid bands (VIS, NIR-Y, NIR-H, NIR-J)
22+
> - FITS structure assumes one file per channel/filter
23+
>
24+
> For other surveys, you may need to adjust these settings or disable flux conversion (`config.apply_flux_conversion = False`).
25+
1126
## Support for Datalabs Users
1227

1328
For users experiencing problems with Cutana in the ESA Datalabs environment, please open a service desk ticket at: https://support.cosmos.esa.int/situ-service-desk/servicedesk/customer/portal/5
1429

1530
## Quick Start
1631
### Installation
1732

33+
```bash
34+
pip install cutana
35+
```
36+
37+
Or for development:
1838
```bash
1939
# Create conda environment
2040
conda env create -f environment.yml

assets/cutana_demo_2x.gif

2.59 MB
Loading

0 commit comments

Comments
 (0)