Metadata-Version: 2.4
Name: indica
Version: 0.1.19
Summary: INtegrated DIagnostiC Analysis
License: GPL-3.0-or-later
License-File: LICENSE.md
Author: Marco Sertoli
Author-email: marco.sertoli@tokamakenergy.com
Maintainer: Evie Litherland-Smith
Maintainer-email: evie.litherland-smith@ukaea.uk
Requires-Python: >=3.9,<3.13
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: GitPython (>=3.1.41,<4.0.0)
Requires-Dist: Pint (>=0.23,<0.24)
Requires-Dist: bottleneck (==1.4.0)
Requires-Dist: corner (>=1.0,<2.0)
Requires-Dist: dime_sampler (==1.0.0)
Requires-Dist: emcee (>=3.1.4,<4.0.0)
Requires-Dist: flatdict (>=4.0.1,<5.0.0)
Requires-Dist: freeqdsk (>=0.5.0,<0.6.0)
Requires-Dist: hydra-core (>=1.3.1,<2.0.0)
Requires-Dist: matplotlib (>=3.8.0,<4.0.0)
Requires-Dist: mpmath (>=1.3.0,<2.0.0)
Requires-Dist: netCDF4 (>=1.5.4,<2.0.0)
Requires-Dist: numpy (==1.26.4)
Requires-Dist: pandas (==2.2.1)
Requires-Dist: periodictable (>=1.6.1,<2.0.0)
Requires-Dist: prov (>=1.5.3,<2.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: sal (>=1.2.2,<2.0.0)
Requires-Dist: scikit-learn (>=1.3.0,<2.0.0)
Requires-Dist: scikit-optimize (>=0.10.2,<0.11.0)
Requires-Dist: scipy (>=1.9.2,<2.0.0)
Requires-Dist: tqdm (>=4.65.0,<5.0.0)
Requires-Dist: xarray (==2024.6.0)
Project-URL: Repository, https://github.com/indica-mcf/Indica
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 perform and combine the analysis of a large number of different diagnostics from Magnetic Confined Fusion (MCF) plasma devices. It will consist of a library of functions to analyse different diagnostic systems under a common framework, and a set of workflows to combine these measurements.  <!--- Test for pre-commit -->

The overall design work has been completed and the general functionality implemented, but the library is still under active development.
<!--In  addition to the (rapidly changing) code, this repository holds the documentation for this project, [which can be found on ReadTheDocs](https://indica-ukaea.readthedocs.io/en/latest/), which is also still (rapidly) changing.-->

## Creation of development environment
1. Upgrade pip:
    - *pip install --upgrade pip*

2. Create a virtual environment with python 3.11 and activate it, e.g. using conda:
   - *set_global_conda*
   - *conda create --name ENV_NAME python=3.11*
   - *conda activate ENV_NAME*

3. Install poetry and environment dependencies:
    - *pip install poetry==1.7*
    - *poetry install*

4. For mdsplus building and installation, e.g. from a local mdsplus directory:
   - *cp -r /usr/local/mdsplus/mdsobjects/python mdsPython*
   - *cd mdsPython*
   - *python setup.py build*
   - *python setup.py install*
   - *cd ../*
   - *rm -r mdsPython*

## License

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

