madrigal-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,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,4 @@
|
|
|
1
|
+
madrigal_jl-0.1.0.dist-info/METADATA,sha256=wzHOkXjGiwZv_tdxhPZ9yOqkVkRMm-vfHbpCyUUtHyE,2150
|
|
2
|
+
madrigal_jl-0.1.0.dist-info/WHEEL,sha256=Wb0ASbVj8JvWHpOiIpPi7ucfIgJeCi__PzivviEAQFc,90
|
|
3
|
+
madrigal_jl-0.1.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
4
|
+
madrigal_jl-0.1.0.dist-info/RECORD,,
|