Metadata-Version: 2.4
Name: indica
Version: 0.1.26
Summary: INtegrated DIagnostiC Analysis
Author: Marco Sertoli, Chris MacMackin, Michael Gemmell, Evie Litherland-Smith
Author-email: Marco Sertoli <marco.sertoli@tokamakenergy.com>, Chris MacMackin <chris.macmackin@ukaea.uk>, Michael Gemmell <michael.gemmell@tokamakenergy.com>, Evie Litherland-Smith <evie.litherland-smith@ukaea.uk>
License-Expression: GPL-3.0-or-later
Requires-Dist: mdsthin
Requires-Dist: corner>=1.0
Requires-Dist: pandas>=2.2.1
Requires-Dist: hydra-core>=1.3.1
Requires-Dist: prov>=1.5.3
Requires-Dist: netcdf4>=1.5.4
Requires-Dist: numpy>=1.26.4
Requires-Dist: mpmath>=1.3.0
Requires-Dist: scipy>=1.13.1
Requires-Dist: xarray>=2022.1.0
Requires-Dist: matplotlib>=3.8.0
Requires-Dist: sal>=1.2.2
Requires-Dist: emcee>=3.1.4
Requires-Dist: dime-sampler==1.0.0
Requires-Dist: flatdict>=4.1.0
Requires-Dist: bottleneck==1.4.0
Requires-Dist: tqdm>=4.65.0
Requires-Dist: scikit-learn>=1.3.0
Requires-Dist: scikit-optimize>=0.10.2
Requires-Dist: pyyaml>=6.0.1
Requires-Dist: pint>=0.23
Requires-Dist: gitpython>=3.1.41
Requires-Dist: periodictable>=1.6.1
Requires-Dist: freeqdsk>=0.5.0
Requires-Dist: pyproject-metadata>=0.12.1 ; extra == 'aurora'
Requires-Dist: scikit-build-core<0.8 ; extra == 'aurora'
Requires-Dist: scipy==1.13.1 ; extra == 'aurora'
Requires-Dist: numpy==1.26.4 ; extra == 'aurora'
Requires-Dist: pandas==2.2.1 ; extra == 'aurora'
Requires-Dist: h5py>=3.0 ; extra == 'fidasim'
Requires-Dist: scikit-image>=0.20 ; extra == 'fidasim'
Maintainer: Evie Litherland-Smith, Michael Gemmell, Jussi Hakosalo
Maintainer-email: Evie Litherland-Smith <evie.litherland-smith@ukaea.uk>, Michael Gemmell <michael.gemmell@tokamakenergy.com>, Jussi Hakosalo <jussi.hakosalo@tokamakenergy.com>
Requires-Python: >=3.12, <3.13
Project-URL: repository, https://github.com/indica-mcf/Indica
Provides-Extra: aurora
Provides-Extra: fidasim
Description-Content-Type: text/markdown

# InDiCA

[![Documentation
Status](https://readthedocs.org/projects/indica-ukaea/badge/?version=latest)](https://indica-ukaea.readthedocs.io/en/latest/?badge=latest)
[![tests](https://github.com/ukaea/Indica/workflows/tests/badge.svg)](https://github.com/ukaea/Indica/actions?query=workflow%3Atests)
[![linting](https://github.com/ukaea/Indica/workflows/linting/badge.svg)](https://github.com/ukaea/Indica/actions?query=workflow%3Alinting)
[![codecov](https://codecov.io/gh/ukaea/Indica/branch/master/graph/badge.svg?token=6VJ5J4JRA2)](https://codecov.io/gh/ukaea/Indica)

InDiCA (**In**tegrated **Di**agnosti**C** **A**nalysis) is a tool which allows to read, analyse, and model data from a wide variety of diagnostics for Magnetic Confined Fusion (MCF) devices. Combined under a common framework, diagnostic models and experimental data can be seemlessly compared, analysis and inference workflows can be implemented and tested on real as well as synthetic data. Reading functionallity is currently implemented for JET and ST40 tokamaks.

## Development environment using [uv](https://docs.astral.sh/uv/)
- The recommended UV-managed environment is CPython 3.12.
- Create or refresh it with `uv venv .venv`.
- Run `uv sync --frozen` to let `uv` install InDiCA and the development dependencies into that environment.
- Add optional dependencies with `uv sync --extra <extraname> --frozen` or `uv sync --all-extras --frozen`.
- Adding using `uv add` keeps the `uv.lock` file up-to-date automatically.

### [Aurora](https://github.com/fsciortino/Aurora) install instructions
Currently there's a build-system issue due to `scikit_build` version, so Aurora is not automatically installed. To install:
1. `uv sync --extra aurora --frozen` or `uv sync --all-extras --frozen` to get the build requirements into the UV environment
2. `uv pip install --python .venv/bin/python --no-build-isolation aurorafusion` to install the package into the active environment

## License
InDiCA is distributed under the [GNU General Public License version
3](LICENSE.md) or, at your option, any later version.
