madrigal-jl 0.1.0__tar.gz

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,74 @@
1
+ Metadata-Version: 2.4
2
+ Name: madrigal-jl
3
+ Version: 0.1.0
4
+ Summary: Python wrapper for Madrigal.jl - access the Madrigal database via Julia
5
+ Keywords: madrigal,julia,atmospheric-science,ionosphere
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 :: Atmospheric Science
11
+ Project-URL: Homepage, https://github.com/JuliaSpacePhysics/Madrigal.jl
12
+ Project-URL: Repository, https://github.com/JuliaSpacePhysics/Madrigal.jl
13
+ Requires-Python: >=3.9
14
+ Requires-Dist: juliacall>=0.9.20
15
+ Description-Content-Type: text/markdown
16
+
17
+ # Madrigal
18
+
19
+ Python wrapper for [Madrigal.jl](https://github.com/JuliaSpacePhysics/Madrigal.jl) - access the Madrigal upper atmospheric science database from Python.
20
+
21
+ ## Installation
22
+
23
+ With pip (requires Julia to be installed separately):
24
+
25
+ ```bash
26
+ pip install madrigal-jl
27
+ ```
28
+
29
+ With pixi (installs Julia automatically):
30
+
31
+ ```bash
32
+ pixi add madrigal-jl
33
+ ```
34
+
35
+ The Julia package installs automatically on first use.
36
+
37
+ ## Usage
38
+
39
+ ```python
40
+ import madrigal
41
+
42
+ # Get all instruments
43
+ instruments = madrigal.get_instruments()
44
+
45
+ # Get experiments for Millstone Hill radar (kinst=30)
46
+ experiments = madrigal.get_experiments(30, "2020-01-01", "2020-01-31")
47
+
48
+ # Get files from an experiment
49
+ files = madrigal.get_experiment_files(experiments[0])
50
+
51
+ # Download a file
52
+ path = madrigal.download_file(files[0])
53
+ ```
54
+
55
+ ## Configuration
56
+
57
+ ```python
58
+ madrigal.set_default_server("https://cedar.openmadrigal.org")
59
+ madrigal.set_default_user("Your Name", "email@example.com", "Institution")
60
+ ```
61
+
62
+ ## API
63
+
64
+ All functions from Madrigal.jl are available:
65
+
66
+ - `get_instruments(server=None, source=:cache)`
67
+ - `get_experiments(code, t0, t1, server=None, source=:cache)`
68
+ - `get_experiment_files(experiment, server=None, source=:cache)`
69
+ - `get_experiment_file_parameters(file, server=None)`
70
+ - `download_file(file, destination=None, format=:hdf5, ...)`
71
+ - `download_files(inst, kindat, t0, t1, ...)`
72
+ - `get_metadata(id, server=None)`
73
+
74
+ See the [Madrigal.jl documentation](https://juliaspacePhysics.github.io/Madrigal.jl) for full details.
@@ -0,0 +1,58 @@
1
+ # Madrigal
2
+
3
+ Python wrapper for [Madrigal.jl](https://github.com/JuliaSpacePhysics/Madrigal.jl) - access the Madrigal upper atmospheric science database from Python.
4
+
5
+ ## Installation
6
+
7
+ With pip (requires Julia to be installed separately):
8
+
9
+ ```bash
10
+ pip install madrigal-jl
11
+ ```
12
+
13
+ With pixi (installs Julia automatically):
14
+
15
+ ```bash
16
+ pixi add madrigal-jl
17
+ ```
18
+
19
+ The Julia package installs automatically on first use.
20
+
21
+ ## Usage
22
+
23
+ ```python
24
+ import madrigal
25
+
26
+ # Get all instruments
27
+ instruments = madrigal.get_instruments()
28
+
29
+ # Get experiments for Millstone Hill radar (kinst=30)
30
+ experiments = madrigal.get_experiments(30, "2020-01-01", "2020-01-31")
31
+
32
+ # Get files from an experiment
33
+ files = madrigal.get_experiment_files(experiments[0])
34
+
35
+ # Download a file
36
+ path = madrigal.download_file(files[0])
37
+ ```
38
+
39
+ ## Configuration
40
+
41
+ ```python
42
+ madrigal.set_default_server("https://cedar.openmadrigal.org")
43
+ madrigal.set_default_user("Your Name", "email@example.com", "Institution")
44
+ ```
45
+
46
+ ## API
47
+
48
+ All functions from Madrigal.jl are available:
49
+
50
+ - `get_instruments(server=None, source=:cache)`
51
+ - `get_experiments(code, t0, t1, server=None, source=:cache)`
52
+ - `get_experiment_files(experiment, server=None, source=:cache)`
53
+ - `get_experiment_file_parameters(file, server=None)`
54
+ - `download_file(file, destination=None, format=:hdf5, ...)`
55
+ - `download_files(inst, kindat, t0, t1, ...)`
56
+ - `get_metadata(id, server=None)`
57
+
58
+ See the [Madrigal.jl documentation](https://juliaspacePhysics.github.io/Madrigal.jl) for full details.
@@ -0,0 +1,63 @@
1
+ [project]
2
+ name = "madrigal-jl"
3
+ version = "0.1.0"
4
+ description = "Python wrapper for Madrigal.jl - access the Madrigal database via Julia"
5
+ readme = "README.md"
6
+ license = "MIT"
7
+ requires-python = ">=3.9"
8
+ keywords = [
9
+ "madrigal",
10
+ "julia",
11
+ "atmospheric-science",
12
+ "ionosphere",
13
+ ]
14
+ classifiers = [
15
+ "Development Status :: 4 - Beta",
16
+ "Intended Audience :: Science/Research",
17
+ "Programming Language :: Python :: 3",
18
+ "Topic :: Scientific/Engineering :: Atmospheric Science",
19
+ ]
20
+ dependencies = [
21
+ "juliacall>=0.9.20",
22
+ ]
23
+
24
+ [project.urls]
25
+ Homepage = "https://github.com/JuliaSpacePhysics/Madrigal.jl"
26
+ Repository = "https://github.com/JuliaSpacePhysics/Madrigal.jl"
27
+
28
+ [build-system]
29
+ requires = [
30
+ "pdm-backend",
31
+ ]
32
+ build-backend = "pdm.backend"
33
+
34
+ [tool.pdm.build]
35
+ package-dir = "src"
36
+ includes = [
37
+ "madrigal",
38
+ ]
39
+
40
+ [tool.pixi.workspace]
41
+ channels = [
42
+ "conda-forge",
43
+ ]
44
+ platforms = [
45
+ "linux-64",
46
+ "osx-arm64",
47
+ "osx-64",
48
+ "win-64",
49
+ ]
50
+
51
+ [tool.pixi.dependencies]
52
+ pdm = "*"
53
+
54
+ [tool.pixi.pypi-dependencies]
55
+ pytest = "*"
56
+ twine = "*"
57
+
58
+ [tool.pixi.pypi-dependencies.madrigal-jl]
59
+ path = "."
60
+ editable = true
61
+
62
+ [tool.pixi.tasks]
63
+ test = "pytest"
File without changes
@@ -0,0 +1,7 @@
1
+ import pytest
2
+
3
+ def test_import():
4
+ import madrigal
5
+ assert hasattr(madrigal, "get_instruments")
6
+ assert hasattr(madrigal, "get_experiments")
7
+ assert hasattr(madrigal, "download_file")