Metadata-Version: 2.5
Name: golem-toolkit
Version: 0.1.2
Summary: GOLEM toolkit.
Project-URL: Homepage, https://gitlab.com/golem-tokamak/it/golem-toolkit
Project-URL: Issues, https://gitlab.com/golem-tokamak/it/golem-toolkit/-/issues
Author-email: Václav Sedmidubský <vasek7d@gmail.com>
License: MIT License
        
        Copyright (c) 2025 Václav Sedmidubský
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: DAS,GOLEM,diagnostics,plasma,tokamak
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Requires-Dist: xarray
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: pytest>=8; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# golem-toolkit

Python toolkit for GOLEM tokamak data loading, probe analysis, and related utilities.

Canonical repository: [`golem-tokamak/it/golem-toolkit`](https://gitlab.com/golem-tokamak/it/golem-toolkit).

## On GOLEM servers (python-pixi)

The shared IT environment [python-pixi](https://gitlab.com/golem-tokamak/it/python-pixi) already includes this package from PyPI. On the servers:

```bash
source /opt/python-pixi/activate
python -c "import golem_toolkit; print('OK')"
```

Admins add or bump the pin with `pixi add --pypi golem-toolkit` in that repository (prefer conda-forge for dependencies; this package stays on PyPI). See [docs/RELEASE.md](docs/RELEASE.md) for publishing a new version.

## Installation (elsewhere)

```bash
pip install golem-toolkit
```

Requires Python >=3.9 (tested with the python-pixi stack on Python 3.14).

## Development

Clone the repository, then either:

**Editable install with pip** (any supported Python):

```bash
pip install -e ".[dev]"
pytest
```

**Pixi-style check** (same major Python as python-pixi):

```bash
pixi init   # or reuse a local pixi workspace
pixi add python=3.14 numpy scipy pandas xarray matplotlib h5py pytest
pixi add --pypi --editable .
pixi run pytest
```

Runtime dependencies (`numpy`, `scipy`, `pandas`, `xarray`, `matplotlib`) match packages already provided from conda-forge in python-pixi.

## Testing apps against python-pixi (WSL)

IT’s python-pixi environment is **`linux-64` only**. On Windows, use **WSL** to mirror the GOLEM servers:

```bash
# one-time: install pixi in WSL if needed, then:
git clone git@gitlab.com:golem-tokamak/it/python-pixi.git ~/python-pixi
cd ~/python-pixi
pixi install --frozen
source ./activate
python -c "import golem_toolkit; print('OK')"
```

Day to day:

```bash
source ~/python-pixi/activate
cd /path/to/your/app
python app.py    # or: streamlit run ...
```

For **unreleased** golem-toolkit changes, publish a release (preferred for server parity) or use a personal pixi project with an editable path to your clone—do not modify the shared server env.

## Releasing to PyPI

Tag `main` as `vX.Y.Z` and push the tag; CI uploads to PyPI. Full checklist: [docs/RELEASE.md](docs/RELEASE.md).

Licensed under the MIT License – see [LICENSE](LICENSE) for details.
