golem-toolkit 0.1.0__tar.gz

golem_toolkit-0.1.0/.gitignore

@@ -0,0 +1,190 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+.venv*/
+.conda/
+.mamba/
+.micromamba/
+.pixi/
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+.vscode/
+
+# Local shell dumps
+_Empty_Source_Shells/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore

golem_toolkit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+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.

golem_toolkit-0.1.0/PKG-INFO

@@ -0,0 +1,111 @@
+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.

golem_toolkit-0.1.0/README.md

@@ -0,0 +1,64 @@
+# 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.

golem_toolkit-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling>=1.25", "hatch-vcs>=0.4"]
+build-backend = "hatchling.build"
+
+[project]
+name = "golem-toolkit"
+description = "GOLEM toolkit."
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "numpy",
+    "pandas",
+    "matplotlib",
+    "xarray",
+    "scipy",
+]
+license = { file = "LICENSE" }
+authors = [{ name = "Václav Sedmidubský", email = "vasek7d@gmail.com" }]
+dynamic = ["version"]
+keywords = ["tokamak", "GOLEM", "diagnostics", "plasma", "DAS"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/vasek7d/golem_toolkit"
+Issues = "https://github.com/vasek7d/golem_toolkit/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "build", "twine", "ruff", "mypy"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/golem_toolkit", "README.md", "LICENSE", "tests"]
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/golem_toolkit"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"
+markers = [
+    "network: tests that require an internet connection",
+]

golem_toolkit-0.1.0/src/golem_toolkit/__init__.py

@@ -0,0 +1,5 @@
+__all__ = [
+	"hello_package",
+	"loading",
+	"probes",
+]

golem_toolkit-0.1.0/src/golem_toolkit/hello_package/hello.py

@@ -0,0 +1,2 @@
+def hello(): 
+    return 'Hello from test_package!'