# Installation

**This package requires Python 3.9 or above.**

ops-data-client can be installed using artifactory PyPI repository:

```bash
pip install ops-data-client --user -i https://artifactory.esss.lu.se/artifactory/api/pypi/pypi-virtual/simple
```

A configuration file is needed for running ops-data-client via both the command line
interface and from python scripts.

The default location for the configuration file is:
```bash
$HOME/.ops-config.ini
```

Create the above file, and place in it the following contents:
```ini
[archiver-tn]
type = archiver
host = archiver-linac-01.tn.esss.lu.se
port = 17665
protocol = http

[sds-hdf5]
type = sds-hdf5
host = sds-retriever.cyolo.ess.eu
port = 443
protocol = https

[sds-storage]
type = sds-storage
host = sds-db01.tn.esss.lu.se
port = 9000
user = sds_readonly
database = sds
table = data
```
Additional data sources can be added in the same fashion (just Archiver and SDS sources
at present).


Example python code to be be run where SDS data is accessible, like in JupyterHub:

```python
from ops_data_client import get_data
dataframe = get_data(
    pvs=["RFQ-010:RFS-Cav-110:Fld-Wave_SDS-DODData"],
    start="2025-06-11 04:06:25.925641123",
    end="2025-06-11 04:06:26.782784123456"
)
dataframe
```

![installation-example-python.png](images/installation-example-python.png)