Metadata-Version: 2.4
Name: nomad-camels-toolbox
Version: 0.4.2
Summary: This package provides easy access to data generated with nomad-camels
License-File: LICENSE
Author: nomad-camels team
Author-email: nomad-camels@fau.de
Requires-Python: >=3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: all
Provides-Extra: pandas
Provides-Extra: plotly
Provides-Extra: qt
Requires-Dist: PySide6 (>=6.6.0) ; extra == "all"
Requires-Dist: PySide6 (>=6.6.0) ; extra == "qt"
Requires-Dist: h5py (>=3.11.0,<4.0.0)
Requires-Dist: lmfit (>=0.1.2) ; extra == "all"
Requires-Dist: lmfit (>=0.1.2) ; extra == "plotly"
Requires-Dist: pandas (>=2.2.3,<3.0.0) ; extra == "all"
Requires-Dist: pandas (>=2.2.3,<3.0.0) ; extra == "pandas"
Requires-Dist: pandas (>=2.2.3,<3.0.0) ; extra == "plotly"
Requires-Dist: plotly (>=5.15.0) ; extra == "all"
Requires-Dist: plotly (>=5.15.0) ; extra == "plotly"
Requires-Dist: pyqtgraph (>=0.13.3) ; extra == "all"
Requires-Dist: pyqtgraph (>=0.13.3) ; extra == "qt"
Description-Content-Type: text/markdown

# NOMAD CAMELS toolbox

This package provides easy access to data generated with [NOMAD CAMELS](https://github.com/FAU-LAP/NOMAD-CAMELS).

Simplify your data evaluation with the NOMAD CAMELS toolbox!
More information about the toolbox can be found in the [documentation of NOMAD CAMELS](https://fau-lap.github.io/NOMAD-CAMELS/doc/nomad_camels_toolbox.html).

## Optional Dependencies
To install the NOMAD CAMELS toolbox, run
```
pip install nomad-camels-toolbox[all]
```
in the Python environment you use for your evaluation. This installs all optional dependencies to use the full functionality. The following options are all included when using `all`.

Single installation options can be installed by using `pip install nomad-camels-toolbox[option-name]` ([see pip install documentation](https://pip.pypa.io/en/stable/cli/pip_install/)). The options are:
- `pandas`: This installs `pandas` as a powerful package for data evaluation along with the toolbox, so the data can be read directly as a [pandas.DataFrame](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html).
- `plotly`: Installs [plotly](https://pypi.org/project/plotly/), [lmfit](https://pypi.org/project/lmfit/) and [pandas](https://pypi.org/project/pandas/). It enables to automatically recreate the plots made in CAMELS, using plotly figures.
- `qt`: Installs [PySide6](https://pypi.org/project/PySide6/) and [pyqtgraph](https://pypi.org/project/pyqtgraph/). This is used to provide a GUI, to quickly investigate data from CAMELS.



# Changelog

### 0.4.2
- fixed broken check for the used camels-suitcase version. If a session name was given in CAMELS it would fail to recreate plots. 

### 0.4.1
Fixes:
- fixed broken import of the modules methods

### 0.4.0
- Can now recreate plots from CAMELS files using suitcase-nomad-camels-hdf5 version > 1.0.0

   Fully supports complex nested protocols and multiple plots with fits. 

   -- BROKEN -- use version 0.4.1

### 0.3.2
- Display data as points and fits as dashed lines

### 0.3.0
- Now compatible with more nested data structure from CAMELS 1.9.0

### 0.2.9
- added direct link to the toolbox documentation

### 0.2.8
- Fixed a bug when using data_set_key

### 0.2.7
- made selection of dataset in reader more intuitive

### 0.2.4
- plots now show legend over the plot, not anymore making the plot tiny
- fixed optional dependencies

### 0.2.3
- fixed plots not being made if two plots had the same name

### 0.2.2
Fixes:
- fixed import problems

### 0.2.1
Features:
- custom plots in qt-viewer

Fixes:
- installation fixed
- qt viewer more stable

## 0.2.0
Features:
- Recreating plots from CAMELS with a single function
- UI tool to view data in a simplified way

### 0.1.2
Fixes:
- fixed returning of dataframes for different shapes of the data

