Metadata-Version: 2.4
Name: golem-toolkit
Version: 0.1.0
Summary: GOLEM toolkit.
Project-URL: Homepage, https://github.com/vasek7d/golem_toolkit
Project-URL: Issues, https://github.com/vasek7d/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

GOLEM toolkit.

## Installation

This package is not yet available on PyPI or conda-forge. You need to download or clone the repository locally to install it.

### Using Anaconda

1. **Download or clone the repository** to your local machine.

2. **Navigate to the repository directory**:
   ```bash
   cd golem_toolkit
   ```

3. **(Optional) Create a new conda environment** with Python >=3.9:
   ```bash
   conda create -n golem-toolkit python>=3.9
   ```

4. **Activate your conda environment**:
   ```bash
   conda activate golem-toolkit
   ```

5. **Install the package** from the local directory:
   
   For regular installation:
   ```bash
   pip install .
   ```
   
   For editable/development installation (recommended for development):
   ```bash
   pip install -e .
   ```

6. **Optional: Install development dependencies**:
   ```bash
   pip install -e ".[dev]"
   ```

## Active probe IV correction

Module `golem_toolkit.probes` corrects raw shunt current (CH1) and divider output (CH2) to tip voltage and probe current using calibration NetCDF files.

```python
from golem_toolkit.probes import load_iv_calibration, process_iv_signals

calib = load_iv_calibration("active_probe_calib.nc")
ds = process_iv_signals(I_raw, U_raw, calibration=calib, mode="ac", f0_hz=20_000.0)
# Conductance at f0: Re(ds.attrs["I_probe_phasor"] / ds.attrs["U_true_phasor"])
# IV plot: ds["U_true"] vs ds["I_probe"] (waveform keeps harmonics/noise)
```

Documentation: [docs/probes/IV_CORRECTION.md](docs/probes/IV_CORRECTION.md), [docs/probes/NAMING.md](docs/probes/NAMING.md).

Generate calibration from circuit_test: `python active_voltage_divider_test/export_iv_calibration.py`.

---

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