Metadata-Version: 2.4
Name: edpsplot
Version: 0.3.0
Summary: EDPS Dashboard
Home-page: https://www.eso.org/sci/software/edps.html
Author: Stefano Zampieri
Author-email: szampier@eso.org
License: BSD-3-Clause
Project-URL: Bug Tracker, https://jira.eso.org/
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: panel
Requires-Dist: astropy
Requires-Dist: hvplot
Requires-Dist: xarray
Requires-Dist: datashader
Dynamic: license-file

# edpsplot

Interactive dashboard for visualizing [EDPS](https://www.eso.org/sci/software/edps.html) data reduction
products. Built on [Panel](https://panel.holoviz.org/) and [hvPlot](https://hvplot.holoviz.org/), it renders
interactive plots of FITS files produced by ESO instrument pipelines.

## Building from source

```bash
git clone https://gitlab.eso.org/szampier/edps-plot.git
cd edps-plot
python3 -m venv build_env
. build_env/bin/activate
pip install build
python3 -m build   # package is created in dist/
```

## Installation

```bash
python3 -m venv edpsplot_env
. edpsplot_env/bin/activate
pip install dist/edpsplot-*.tar.gz
```

Or install directly from source for development:

```bash
pip install -e .
```

## Configuration

| Environment variable | Description | Default |
|---|---|---|
| `EDPS_DATA` | Root directory where EDPS stores reduction results | `~/EDPS_data` |

Expected directory layout under `EDPS_DATA`:

```
{EDPS_DATA}/
  {INSTRUMENT}/
    {TASK}/
      {JOB_ID}/
        recipe_inputs_outputs.sof
```

## Running the dashboard

```bash
panel serve src/edpsplot/edps-plot.py --show
```

Navigate to the URL printed by Panel (typically `http://localhost:5006`).
Use the instrument / task / job selectors to browse reduction results, or
append `?job_id=<JOB_ID>` to the URL to jump directly to a specific job.

To stop the server, press **Ctrl-C** in the terminal.

## Supported instruments

UVES, ESPRESSO, MUSE, KMOS, X-SHOOTER, CRIRES, FORS2, HAWKI, SPHERE, GIRAFFE, ERIS, VISIR
