Metadata-Version: 2.4
Name: sunpy-regards
Version: 1.0.0
Summary: SunPy Fido client for the REGARDS archive at MEDOC.
Author-email: Salim Hachemaoui <salim.hachemaoui@group-dsi.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://git.ias.u-psud.fr/medoc/sunpy-regards
Project-URL: Source, https://git.ias.u-psud.fr/medoc/sunpy-regards
Project-URL: Issues, https://git.ias.u-psud.fr/medoc/sunpy-regards/-/issues
Keywords: sunpy,astronomy,solar,regards,medoc,fido
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: sunpy[all]>=7.0
Requires-Dist: astropy>=5.0
Requires-Dist: requests>=2.31
Requires-Dist: python-dotenv>=1.0
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: python-semantic-release; extra == "dev"


# sunpy-regards

**SunPy/Fido plugin** for searching and downloading solar data from the  
**REGARDS archive (MEDOC – Solar tenant)**.

Adds a new **`regards` provider** to `sunpy.net.Fido`.

---

## 🚀 Quick start

### Install
```bash
pip install sunpy-regards
````

### Configure

Create a `.env` file (or export environment variables):

```env
REGARDS_BASE_URL=https://regards.osups.universite-paris-saclay.fr
REGARDS_TENANT=Solar
REGARDS_USERNAME=your_username
REGARDS_PASSWORD=your_password
```

---

## 🛰️ Supported datasets (current public list)

Datasets are defined in REGARDS and may evolve over time.
Current public datasets include:

* **SDO / AIA** — `GAIA-DEM data` *(label: GAIA-DEM)*
* **SOHO / CELIAS** — `SOHO data` *(label: SOHO)*
* **Solar Orbiter / PHI** — `Solar Orbiter data` *(label: Solar-Orbiter)*
* **STEREO / SECCHI** — `STEREO data` *(label: STEREO)*
* **TRACE / TRACE** — `TRACE data` *(label: TRACE)*

Tip: you can use these values in `r.Dataset(...)` and `r.Observatory(...)`.

---

## Use with SunPy/Fido

```python
from sunpy.net import Fido
import sunpy.net.attrs as a
from sunpy.net.attrs import regards as r

results = Fido.search(
    a.Time("2023-03-17", "2023-03-19"),
    r.Observatory("SDO"),
    a.Instrument("AIA"),
    r.Dataset("GAIA-DEM data"),
)

Fido.fetch(results, path="./downloads/{file}")
```

---

## ℹ️ Notes

* Python **≥ 3.11**, SunPy **≥ 7**
* REGARDS credentials are required for full functionality
* Dataset discovery is dynamic when credentials are available
* Project status: **Alpha**

---

## 🔗 Links

* REGARDS archive: [https://regards.osups.universite-paris-saclay.fr](https://regards.osups.universite-paris-saclay.fr)
* SunPy: [https://sunpy.org](https://sunpy.org)



