Metadata-Version: 2.4
Name: metsuperq
Version: 0.2.2
Summary: Standardized analysis package for the MetSuperQ project: extract qubit coherence metrics (quantities of interest) from measurements across various project partners and store them in InfluxDB for cross-comparison.
Maintainer-email: Mahmut Çetin <mahmut@orangeqs.com>, Hiresh Jadoenathmissier <hiresh@orangeqs.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://opensource.orangeqs.info/metsuperq/
Project-URL: Documentation, https://opensource.orangeqs.info/metsuperq/
Project-URL: Repository, https://code.orangeqs.com/opensource/metsuperq
Project-URL: Issues, https://code.orangeqs.com/opensource/metsuperq/-/issues
Project-URL: Changelog, https://code.orangeqs.com/opensource/metsuperq/-/blob/main/CHANGELOG.md
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: h5py>=3.16.0
Requires-Dist: influxdb-client>=1.50.0
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.4.4
Requires-Dist: psutil>=7.2.2
Requires-Dist: pydantic>=2.12.5
Requires-Dist: pydantic-settings>=2.13.1
Requires-Dist: qcodes>=0.57.0
Requires-Dist: scipy>=1.17.1
Dynamic: license-file

# MetSuperQ

[![PyPI](https://img.shields.io/pypi/v/metsuperq)](https://pypi.org/project/metsuperq/)
[![Python](https://img.shields.io/badge/python-%3E%3D3.13-blue)](https://pypi.org/project/metsuperq/)
[![CI](https://code.orangeqs.com/opensource/metsuperq/badges/main/pipeline.svg)](https://code.orangeqs.com/opensource/metsuperq/-/pipelines)
[![Docs](https://img.shields.io/badge/docs-online-blue)](https://opensource.orangeqs.info/metsuperq/)
[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD--3--Clause-blue)](https://opensource.org/licenses/BSD-3-Clause)

Standardized analysis package for the [MetSuperQ](https://metsuperq.eu) project — extract qubit coherence metrics (quantities of interest) from measurements across various project partners and store them in InfluxDB for cross-comparison.

## Install

Requires Python 3.13 or later.

```sh
pip install metsuperq
```

## Usage

```python
from metsuperq import analyze_measurement

result = analyze_measurement(
    file_path="/path/to/raw_measurement.hdf5",
    experiment_id="experiment_1",
    device_name="device_1",
    qubit_name="Q1",
    save_outputs=True,
)
```

## Configuration

Create a `config.toml` in the project root with your InfluxDB connection details:

```toml
[influxdb]
url = "your-influxdb-url"
org = "your-org-name"
bucket = "your-bucket-name"
token = "your-token-here"
```

## Development

```sh
git clone https://code.orangeqs.com/opensource/metsuperq.git
cd metsuperq
uv sync
uv run pytest
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

## License

BSD 3-Clause — see [LICENSE](LICENSE).

## Links

- [Documentation](https://opensource.orangeqs.info/metsuperq)
- [Issues](https://code.orangeqs.com/opensource/metsuperq/-/issues)
- [Support](SUPPORT.md)
