tsyganenkomodels-jl 0.1.0__tar.gz

tsyganenkomodels_jl-0.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: tsyganenkomodels-jl
+Version: 0.1.0
+Summary: Python wrapper for TsyganenkoModels.jl - access Tsyganenko magnetic field models via Julia
+Keywords: tsyganenko,julia,space-physics,geomagnetism
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Project-URL: Homepage, https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl
+Project-URL: Repository, https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl
+Requires-Python: >=3.9
+Requires-Dist: juliacall>=0.9.20
+Description-Content-Type: text/markdown
+
+# TsyganenkoModels
+
+Python wrapper for [TsyganenkoModels.jl](https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl) - evaluate Tsyganenko external magnetic field models from Python.
+
+## Installation
+
+```bash
+pip install tsyganenkomodels-jl
+```
+
+The Julia package installs automatically on first use.
+
+## Usage
+
+```python
+import tsyganenkomodels as tm
+import datetime
+
+# Compute the dipole tilt angle (radians)
+ps = tm.dipole_tilt(datetime.datetime(2001, 1, 1, 2, 3, 4))
+
+# Instantiate a model and evaluate GSM field (nT)
+model = tm.T96(pdyn=2.0, dst=-87.0, byimf=2.0, bzimf=-5.0)
+b = model([-5.1, 0.3, 2.8], ps)
+```
+
+## API
+
+Available constructors/functions mirror the Julia package:
+
+- `T89(iopt)`
+- `T96(pdyn, dst, byimf, bzimf)`
+- `T01(pdyn, dst, byimf, bzimf, g1=0.0, g2=0.0)`
+- `TS04(pdyn, dst, byimf, bzimf, g1, g2, g3, w1, w2, w3, w4, w5, w6)`
+- `t89`, `t96`, `t01`, `ts04` (functional wrappers)
+- `dipole_tilt(t)`
+
+See the [TsyganenkoModels.jl documentation](https://JuliaSpacePhysics.github.io/TsyganenkoModels.jl) for full details.

tsyganenkomodels_jl-0.1.0/README.md

@@ -0,0 +1,38 @@
+# TsyganenkoModels
+
+Python wrapper for [TsyganenkoModels.jl](https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl) - evaluate Tsyganenko external magnetic field models from Python.
+
+## Installation
+
+```bash
+pip install tsyganenkomodels-jl
+```
+
+The Julia package installs automatically on first use.
+
+## Usage
+
+```python
+import tsyganenkomodels as tm
+import datetime
+
+# Compute the dipole tilt angle (radians)
+ps = tm.dipole_tilt(datetime.datetime(2001, 1, 1, 2, 3, 4))
+
+# Instantiate a model and evaluate GSM field (nT)
+model = tm.T96(pdyn=2.0, dst=-87.0, byimf=2.0, bzimf=-5.0)
+b = model([-5.1, 0.3, 2.8], ps)
+```
+
+## API
+
+Available constructors/functions mirror the Julia package:
+
+- `T89(iopt)`
+- `T96(pdyn, dst, byimf, bzimf)`
+- `T01(pdyn, dst, byimf, bzimf, g1=0.0, g2=0.0)`
+- `TS04(pdyn, dst, byimf, bzimf, g1, g2, g3, w1, w2, w3, w4, w5, w6)`
+- `t89`, `t96`, `t01`, `ts04` (functional wrappers)
+- `dipole_tilt(t)`
+
+See the [TsyganenkoModels.jl documentation](https://JuliaSpacePhysics.github.io/TsyganenkoModels.jl) for full details.

tsyganenkomodels_jl-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[project]
+name = "tsyganenkomodels-jl"
+version = "0.1.0"
+description = "Python wrapper for TsyganenkoModels.jl - access Tsyganenko magnetic field models via Julia"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+keywords = [
+    "tsyganenko",
+    "julia",
+    "space-physics",
+    "geomagnetism",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+dependencies = [
+    "juliacall>=0.9.20",
+]
+
+[project.urls]
+Homepage = "https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl"
+Repository = "https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl"
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm.build]
+includes = [
+    "src/tsyganenkomodels",
+]
+
+[tool.pixi.workspace]
+channels = [
+    "conda-forge",
+]
+platforms = [
+    "linux-64",
+    "osx-arm64",
+    "osx-64",
+    "win-64",
+]
+
+[tool.pixi.dependencies]
+pdm = "*"
+
+[tool.pixi.pypi-dependencies]
+pytest = "*"
+twine = "*"
+
+[tool.pixi.pypi-dependencies.tsyganenkomodels-jl]
+path = "."
+editable = true
+
+[tool.pixi.tasks]
+test = "pytest"

tsyganenkomodels_jl-0.1.0/src/tsyganenkomodels/__init__.py

@@ -0,0 +1,39 @@
+"""Python wrapper for TsyganenkoModels.jl."""
+
+from juliacall import Main as jl
+
+# Load the Julia package
+jl.seval("using TsyganenkoModels")
+
+# Re-export Julia functions
+t89 = jl.TsyganenkoModels.t89
+t96 = jl.TsyganenkoModels.t96
+t01 = jl.TsyganenkoModels.t01
+ts04 = jl.TsyganenkoModels.ts04
+dipole_tilt = jl.TsyganenkoModels.dipole_tilt
+
+# Model constructors/types
+T89 = jl.TsyganenkoModels.T89
+T96 = jl.TsyganenkoModels.T96
+T01 = jl.TsyganenkoModels.T01
+TS04 = jl.TsyganenkoModels.TS04
+TsyIGRF = jl.TsyganenkoModels.TsyIGRF
+IGRF = jl.TsyganenkoModels.IGRF
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "t89",
+    "t96",
+    "t01",
+    "ts04",
+    "dipole_tilt",
+    "T89",
+    "T96",
+    "T01",
+    "TS04",
+    "TsyIGRF",
+    "IGRF",
+    "__version__",
+    "jl",
+]

tsyganenkomodels_jl-0.1.0/tests/test_wrapper.py

@@ -0,0 +1,19 @@
+import pytest
+
+
+def test_import():
+    import tsyganenkomodels as tm
+
+    assert hasattr(tm, "T96")
+    assert hasattr(tm, "t96")
+    assert hasattr(tm, "dipole_tilt")
+
+
+def test_basic_eval():
+    import tsyganenkomodels as tm
+    import datetime
+
+    ps = tm.dipole_tilt(datetime.datetime(2001, 1, 1, 2, 3, 4))
+    model = tm.T96(pdyn=2.0, dst=-87.0, byimf=2.0, bzimf=-5.0)
+    b = model([-5.1,0.3,2.8], ps)
+    assert len(b) == 3