tsyganenkomodels-jl 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
"""Python wrapper for TsyganenkoModels.jl."""
|
|
2
|
+
|
|
3
|
+
from juliacall import Main as jl
|
|
4
|
+
|
|
5
|
+
# Load the Julia package
|
|
6
|
+
jl.seval("using TsyganenkoModels")
|
|
7
|
+
|
|
8
|
+
# Re-export Julia functions
|
|
9
|
+
t89 = jl.TsyganenkoModels.t89
|
|
10
|
+
t96 = jl.TsyganenkoModels.t96
|
|
11
|
+
t01 = jl.TsyganenkoModels.t01
|
|
12
|
+
ts04 = jl.TsyganenkoModels.ts04
|
|
13
|
+
dipole_tilt = jl.TsyganenkoModels.dipole_tilt
|
|
14
|
+
|
|
15
|
+
# Model constructors/types
|
|
16
|
+
T89 = jl.TsyganenkoModels.T89
|
|
17
|
+
T96 = jl.TsyganenkoModels.T96
|
|
18
|
+
T01 = jl.TsyganenkoModels.T01
|
|
19
|
+
TS04 = jl.TsyganenkoModels.TS04
|
|
20
|
+
TsyIGRF = jl.TsyganenkoModels.TsyIGRF
|
|
21
|
+
IGRF = jl.TsyganenkoModels.IGRF
|
|
22
|
+
|
|
23
|
+
__version__ = "0.1.0"
|
|
24
|
+
|
|
25
|
+
__all__ = [
|
|
26
|
+
"t89",
|
|
27
|
+
"t96",
|
|
28
|
+
"t01",
|
|
29
|
+
"ts04",
|
|
30
|
+
"dipole_tilt",
|
|
31
|
+
"T89",
|
|
32
|
+
"T96",
|
|
33
|
+
"T01",
|
|
34
|
+
"TS04",
|
|
35
|
+
"TsyIGRF",
|
|
36
|
+
"IGRF",
|
|
37
|
+
"__version__",
|
|
38
|
+
"jl",
|
|
39
|
+
]
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tsyganenkomodels-jl
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Python wrapper for TsyganenkoModels.jl - access Tsyganenko magnetic field models via Julia
|
|
5
|
+
Keywords: tsyganenko,julia,space-physics,geomagnetism
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Classifier: Development Status :: 4 - Beta
|
|
8
|
+
Classifier: Intended Audience :: Science/Research
|
|
9
|
+
Classifier: Programming Language :: Python :: 3
|
|
10
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
11
|
+
Project-URL: Homepage, https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl
|
|
12
|
+
Project-URL: Repository, https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl
|
|
13
|
+
Requires-Python: >=3.9
|
|
14
|
+
Requires-Dist: juliacall>=0.9.20
|
|
15
|
+
Description-Content-Type: text/markdown
|
|
16
|
+
|
|
17
|
+
# TsyganenkoModels
|
|
18
|
+
|
|
19
|
+
Python wrapper for [TsyganenkoModels.jl](https://github.com/JuliaSpacePhysics/TsyganenkoModels.jl) - evaluate Tsyganenko external magnetic field models from Python.
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pip install tsyganenkomodels-jl
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
The Julia package installs automatically on first use.
|
|
28
|
+
|
|
29
|
+
## Usage
|
|
30
|
+
|
|
31
|
+
```python
|
|
32
|
+
import tsyganenkomodels as tm
|
|
33
|
+
import datetime
|
|
34
|
+
|
|
35
|
+
# Compute the dipole tilt angle (radians)
|
|
36
|
+
ps = tm.dipole_tilt(datetime.datetime(2001, 1, 1, 2, 3, 4))
|
|
37
|
+
|
|
38
|
+
# Instantiate a model and evaluate GSM field (nT)
|
|
39
|
+
model = tm.T96(pdyn=2.0, dst=-87.0, byimf=2.0, bzimf=-5.0)
|
|
40
|
+
b = model([-5.1, 0.3, 2.8], ps)
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## API
|
|
44
|
+
|
|
45
|
+
Available constructors/functions mirror the Julia package:
|
|
46
|
+
|
|
47
|
+
- `T89(iopt)`
|
|
48
|
+
- `T96(pdyn, dst, byimf, bzimf)`
|
|
49
|
+
- `T01(pdyn, dst, byimf, bzimf, g1=0.0, g2=0.0)`
|
|
50
|
+
- `TS04(pdyn, dst, byimf, bzimf, g1, g2, g3, w1, w2, w3, w4, w5, w6)`
|
|
51
|
+
- `t89`, `t96`, `t01`, `ts04` (functional wrappers)
|
|
52
|
+
- `dipole_tilt(t)`
|
|
53
|
+
|
|
54
|
+
See the [TsyganenkoModels.jl documentation](https://JuliaSpacePhysics.github.io/TsyganenkoModels.jl) for full details.
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
tsyganenkomodels/__init__.py,sha256=N4WgpJOXkMxL5QrLVRkjcJXeTonTa4HV2FW7axv2wLY,761
|
|
2
|
+
tsyganenkomodels_jl-0.1.0.dist-info/METADATA,sha256=r0DjV0eHQTYdKoO731s9IedIGcvlkYolSN1TcQR71cw,1741
|
|
3
|
+
tsyganenkomodels_jl-0.1.0.dist-info/WHEEL,sha256=Wb0ASbVj8JvWHpOiIpPi7ucfIgJeCi__PzivviEAQFc,90
|
|
4
|
+
tsyganenkomodels_jl-0.1.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
5
|
+
tsyganenkomodels_jl-0.1.0.dist-info/RECORD,,
|