Metadata-Version: 2.3
Name: qres-reader
Version: 0.1.7
Summary: A python reader for *.qres binary files
Author: Cristóbal Tapia Camú
Author-email: Cristóbal Tapia Camú <crtapia@gmail.com>
Requires-Dist: numpy>=2.4.4
Requires-Dist: pandas>=3.0.2
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# qres reader for python

This package provides a python API to read binary `*.qres` files generated by the Cubus software.

## Installation

Install via pip with

```bash
pip install python-qres
```

Install via uv with

```bash
uv add python-qres
```

## Quick start ##

You can read the data from a `*.qres`-file as a pandas DataFrame as:

```python
import numpy as np
import matplotlib.pyplot as plt

from cubus_reader import read_cubus_file_as_dataframe

# Read the *.qres file
data = read_cubus_file_as_dataframe('qres_file.qres')

# Plot the data
data.plot()
plt.show()
```

Additionally, the data can be read as an array plus a header dictionary containing the metadata.

```python
import numpy as np
import matplotlib.pyplot as plt

from cubus_reader import read_cubus_file

# Read the *.qres file
header, data = read_cubus_file_as_dataframe('qres_file.qres')
```
