space-mango 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.
Files changed (30) hide show
  1. space_mango-0.1.0/.copier-answers.yml +9 -0
  2. space_mango-0.1.0/.github/workflows/ci.yml +63 -0
  3. space_mango-0.1.0/.github/workflows/publish.yml +45 -0
  4. space_mango-0.1.0/.gitignore +179 -0
  5. space_mango-0.1.0/LICENSE +21 -0
  6. space_mango-0.1.0/Makefile +32 -0
  7. space_mango-0.1.0/PKG-INFO +184 -0
  8. space_mango-0.1.0/README.md +154 -0
  9. space_mango-0.1.0/docker/Dockerfile +27 -0
  10. space_mango-0.1.0/docker/build.sh +6 -0
  11. space_mango-0.1.0/docker/entry_point.sh +2 -0
  12. space_mango-0.1.0/docs/superpowers/plans/2026-03-30-client-package.md +599 -0
  13. space_mango-0.1.0/docs/superpowers/plans/2026-03-30-hive-partitioned-parquet.md +368 -0
  14. space_mango-0.1.0/docs/superpowers/specs/2026-03-30-client-package-design.md +131 -0
  15. space_mango-0.1.0/pyproject.toml +120 -0
  16. space_mango-0.1.0/scripts/convert_pickles.py +123 -0
  17. space_mango-0.1.0/src/space_mango/__init__.py +71 -0
  18. space_mango-0.1.0/src/space_mango/app.py +17 -0
  19. space_mango-0.1.0/src/space_mango/cli.py +35 -0
  20. space_mango-0.1.0/src/space_mango/client.py +128 -0
  21. space_mango-0.1.0/src/space_mango/dataset.py +105 -0
  22. space_mango-0.1.0/src/space_mango/main.py +3 -0
  23. space_mango-0.1.0/src/space_mango/models.py +131 -0
  24. space_mango-0.1.0/src/space_mango/routes/__init__.py +0 -0
  25. space_mango-0.1.0/src/space_mango/routes/data.py +106 -0
  26. space_mango-0.1.0/src/space_mango/routes/health.py +8 -0
  27. space_mango-0.1.0/src/space_mango/worker.py +12 -0
  28. space_mango-0.1.0/tests/test_client.py +151 -0
  29. space_mango-0.1.0/tests/test_placeholder.py +153 -0
  30. space_mango-0.1.0/uv.lock +959 -0
@@ -0,0 +1,9 @@
1
+ # Changes here will be overwritten by Copier. Do not edit manually.
2
+ _commit: v0.2.25
3
+ _src_path: gh:jlevy/simple-modern-uv
4
+ package_author_email: changeme@example.com
5
+ package_author_name: changeme
6
+ package_description: changeme
7
+ package_github_org: changeme
8
+ package_module: changeme
9
+ package_name: changeme
@@ -0,0 +1,63 @@
1
+ # This workflow will install Python dependencies, run tests and lint with a single version of Python
2
+ # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
3
+
4
+ name: CI
5
+
6
+ on:
7
+ push:
8
+ # Use ["main", "master"] for CI only on the default branch.
9
+ # Use ["**"] for CI on all branches.
10
+ branches: ["main", "master"]
11
+ pull_request:
12
+ branches: ["main", "master"]
13
+
14
+ permissions:
15
+ contents: read
16
+
17
+ jobs:
18
+ build:
19
+ strategy:
20
+ matrix:
21
+ # Update this as needed:
22
+ # Common platforms: ["ubuntu-latest", "macos-latest", "windows-latest"]
23
+ os: ["ubuntu-latest"]
24
+ python-version: ["3.11", "3.12", "3.13", "3.14"]
25
+
26
+ # Linux only by default. Use ${{ matrix.os }} for other OSes.
27
+ runs-on: ${{ matrix.os }}
28
+
29
+ steps:
30
+ # Generally following uv docs:
31
+ # https://docs.astral.sh/uv/guides/integration/github/
32
+
33
+ - name: Checkout (official GitHub action)
34
+ uses: actions/checkout@v6
35
+ with:
36
+ # Important for versioning plugins:
37
+ fetch-depth: 0
38
+
39
+ - name: Install uv (official Astral action)
40
+ uses: astral-sh/setup-uv@v7
41
+ with:
42
+ # Update this as needed:
43
+ version: "0.10.2"
44
+ enable-cache: true
45
+ python-version: ${{ matrix.python-version }}
46
+
47
+ - name: Set up Python (using uv)
48
+ run: uv python install
49
+
50
+ # Alternately can use the official Python action:
51
+ # - name: Set up Python (using actions/setup-python)
52
+ # uses: actions/setup-python@v5
53
+ # with:
54
+ # python-version: ${{ matrix.python-version }}
55
+
56
+ - name: Install all dependencies
57
+ run: uv sync --all-extras
58
+
59
+ - name: Run linting
60
+ run: uv run python devtools/lint.py
61
+
62
+ - name: Run tests
63
+ run: uv run pytest
@@ -0,0 +1,45 @@
1
+ name: Publish to PyPI
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+ workflow_dispatch: # Enable manual trigger.
7
+
8
+ jobs:
9
+ build-and-publish:
10
+ runs-on: ubuntu-latest
11
+ environment: pypi
12
+ permissions:
13
+ id-token: write # Mandatory for OIDC.
14
+ contents: read
15
+ steps:
16
+ - name: Checkout (official GitHub action)
17
+ uses: actions/checkout@v6
18
+ with:
19
+ # Important for versioning plugins:
20
+ fetch-depth: 0
21
+
22
+ - name: Install uv (official Astral action)
23
+ uses: astral-sh/setup-uv@v7
24
+ with:
25
+ version: "0.10.2"
26
+ enable-cache: true
27
+ python-version: "3.12"
28
+
29
+ - name: Set up Python (using uv)
30
+ run: uv python install
31
+
32
+ - name: Install all dependencies
33
+ run: uv sync --all-extras
34
+
35
+ - name: Run tests
36
+ run: uv run pytest
37
+
38
+ - name: Build package
39
+ run: uv build
40
+
41
+ - name: Publish to PyPI
42
+ run: uv publish --trusted-publishing always
43
+ # Although uv is newer and faster, the "official" publishing option is the one from PyPA,
44
+ # which uses twine. If desired, replace `uv publish` with:
45
+ # uses: pypa/gh-action-pypi-publish@release/v1
@@ -0,0 +1,179 @@
1
+ # Additions to standard GitHub .gitignore:
2
+ *.bak
3
+ *.orig
4
+ tmp/
5
+ trash/
6
+ attic/
7
+ .kash/
8
+
9
+ # Byte-compiled / optimized / DLL files
10
+ __pycache__/
11
+ *.py[cod]
12
+ *$py.class
13
+
14
+ # C extensions
15
+ *.so
16
+
17
+ # Distribution / packaging
18
+ .Python
19
+ build/
20
+ develop-eggs/
21
+ dist/
22
+ downloads/
23
+ eggs/
24
+ .eggs/
25
+ lib/
26
+ lib64/
27
+ parts/
28
+ sdist/
29
+ var/
30
+ wheels/
31
+ share/python-wheels/
32
+ *.egg-info/
33
+ .installed.cfg
34
+ *.egg
35
+ MANIFEST
36
+
37
+ # PyInstaller
38
+ # Usually these files are written by a python script from a template
39
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
40
+ *.manifest
41
+ *.spec
42
+
43
+ # Installer logs
44
+ pip-log.txt
45
+ pip-delete-this-directory.txt
46
+
47
+ # Unit test / coverage reports
48
+ htmlcov/
49
+ .tox/
50
+ .nox/
51
+ .coverage
52
+ .coverage.*
53
+ .cache
54
+ nosetests.xml
55
+ coverage.xml
56
+ *.cover
57
+ *.py,cover
58
+ .hypothesis/
59
+ .pytest_cache/
60
+ cover/
61
+
62
+ # Translations
63
+ *.mo
64
+ *.pot
65
+
66
+ # Django stuff:
67
+ *.log
68
+ local_settings.py
69
+ db.sqlite3
70
+ db.sqlite3-journal
71
+
72
+ # Flask stuff:
73
+ instance/
74
+ .webassets-cache
75
+
76
+ # Scrapy stuff:
77
+ .scrapy
78
+
79
+ # Sphinx documentation
80
+ docs/_build/
81
+
82
+ # PyBuilder
83
+ .pybuilder/
84
+ target/
85
+
86
+ # Jupyter Notebook
87
+ .ipynb_checkpoints
88
+
89
+ # IPython
90
+ profile_default/
91
+ ipython_config.py
92
+
93
+ # pyenv
94
+ # For a library or package, you might want to ignore these files since the code is
95
+ # intended to run in multiple environments; otherwise, check them in:
96
+ # .python-version
97
+
98
+ # pipenv
99
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
100
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
101
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
102
+ # install all needed dependencies.
103
+ #Pipfile.lock
104
+
105
+ # UV
106
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
107
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
108
+ # commonly ignored for libraries.
109
+ #uv.lock
110
+
111
+ # poetry
112
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
113
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
114
+ # commonly ignored for libraries.
115
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
116
+ #poetry.lock
117
+
118
+ # pdm
119
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
120
+ #pdm.lock
121
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
122
+ # in version control.
123
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
124
+ .pdm.toml
125
+ .pdm-python
126
+ .pdm-build/
127
+
128
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
129
+ __pypackages__/
130
+
131
+ # Celery stuff
132
+ celerybeat-schedule
133
+ celerybeat.pid
134
+
135
+ # SageMath parsed files
136
+ *.sage.py
137
+
138
+ # Environments
139
+ .env
140
+ .venv
141
+ env/
142
+ venv/
143
+ ENV/
144
+ env.bak/
145
+ venv.bak/
146
+
147
+ # Spyder project settings
148
+ .spyderproject
149
+ .spyproject
150
+
151
+ # Rope project settings
152
+ .ropeproject
153
+
154
+ # mkdocs documentation
155
+ /site
156
+
157
+ # mypy
158
+ .mypy_cache/
159
+ .dmypy.json
160
+ dmypy.json
161
+
162
+ # Pyre type checker
163
+ .pyre/
164
+
165
+ # pytype static type analyzer
166
+ .pytype/
167
+
168
+ # Cython debug symbols
169
+ cython_debug/
170
+
171
+ # PyCharm
172
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
175
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
176
+ #.idea/
177
+
178
+ # PyPI configuration file
179
+ .pypirc
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 changeme
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,32 @@
1
+ # Makefile for easy development workflows.
2
+ # See docs/development.md for docs.
3
+ # Note GitHub Actions call uv directly, not this Makefile.
4
+
5
+ .DEFAULT_GOAL := default
6
+
7
+ .PHONY: default install lint test upgrade build clean
8
+
9
+ default: install lint test
10
+
11
+ install:
12
+ uv sync --all-extras
13
+
14
+ lint:
15
+ uv run python devtools/lint.py
16
+
17
+ test:
18
+ uv run pytest
19
+
20
+ upgrade:
21
+ uv sync --upgrade --all-extras --dev
22
+
23
+ build:
24
+ uv build
25
+
26
+ clean:
27
+ -rm -rf dist/
28
+ -rm -rf *.egg-info/
29
+ -rm -rf .pytest_cache/
30
+ -rm -rf .mypy_cache/
31
+ -rm -rf .venv/
32
+ -find . -type d -name "__pycache__" -exec rm -rf {} +
@@ -0,0 +1,184 @@
1
+ Metadata-Version: 2.4
2
+ Name: space-mango
3
+ Version: 0.1.0
4
+ Summary: Python client and server for the MANGO magnetospheric dataset
5
+ Project-URL: Repository, https://github.com/LaboratoryOfPlasmaPhysics/mango
6
+ Author-email: Alexis Jeandet <alexis.jeandet@member.fsf.org>
7
+ License-Expression: GPL-3.0-or-later
8
+ License-File: LICENSE
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Intended Audience :: Science/Research
11
+ Classifier: Operating System :: OS Independent
12
+ Classifier: Programming Language :: Python
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.11
15
+ Classifier: Programming Language :: Python :: 3.12
16
+ Classifier: Programming Language :: Python :: 3.13
17
+ Classifier: Topic :: Scientific/Engineering :: Physics
18
+ Classifier: Typing :: Typed
19
+ Requires-Python: <4.0,>=3.11
20
+ Requires-Dist: httpx>=0.28
21
+ Requires-Dist: polars>=1.0
22
+ Requires-Dist: pyarrow>=18.0
23
+ Provides-Extra: server
24
+ Requires-Dist: cyclopts>=4.10.1; extra == 'server'
25
+ Requires-Dist: fastapi>=0.115; extra == 'server'
26
+ Requires-Dist: gunicorn>=23.0; extra == 'server'
27
+ Requires-Dist: uvicorn-worker>=0.3; extra == 'server'
28
+ Requires-Dist: uvicorn[standard]>=0.34; extra == 'server'
29
+ Description-Content-Type: text/markdown
30
+
31
+
32
+ # MANGO: Magnetospheric Atlas of Normalized Geospace Observations
33
+
34
+ <img width="300" height="300" alt="mangologo" src="https://github.com/user-attachments/assets/5a92150f-ce77-45a8-b15e-8f66ff7cf44b" />
35
+
36
+
37
+ ## Overview
38
+
39
+ **MANGO** is a dataset and Python toolkit for the global analysis of Earth's magnetosphere.
40
+ Unlike raw satellite observations, MANGO provides a **unified, classified, and spatially normalized** view of geospace,
41
+ where each datapoint is contextualized by its magnetospheric region and upstream solar wind conditions and
42
+ repositioned relative to dynamic boundaries like the magnetopause and bow shock.
43
+
44
+ By accounting for the dynamic nature of magnetospheric boundaries,
45
+ MANGO allows researchers to treat disparate satellite observations as part of a single, coherent atlas.
46
+
47
+ ## Key Features
48
+
49
+ Every data point in the MANGO dataset is:
50
+ * **Classified:** Labeled by its specific magnetospheric region (magnetosphere, magnetosheath, solar wind).
51
+ * **Contextualized:** Associated with the causal upstream solar wind conditions retrieved from OMNI data.
52
+ * **Normalized:** Repositioned spatially relative to dynamic boundaries (the bow shock and magnetopause).
53
+
54
+ The Python package provides:
55
+ * A **client** for querying the public MANGO server — returns [Polars](https://pola.rs) DataFrames via Arrow IPC.
56
+ * A **server** (optional) for self-hosting the dataset with FastAPI.
57
+ * **Data-driven filter catalog** — range filters on IMF, solar wind, spatial coordinates, and local plasma parameters.
58
+
59
+
60
+ ---
61
+
62
+ ## Installation
63
+
64
+ ```bash
65
+ # Client only (query the public server)
66
+ pip install space-mango
67
+
68
+ # With server dependencies (self-hosting)
69
+ pip install space-mango[server]
70
+ ```
71
+
72
+ ## Quick Start
73
+
74
+ ```python
75
+ import space_mango as sm
76
+
77
+ # List available regions
78
+ sm.regions()
79
+ # ['magnetosphere', 'magnetosheath', 'solar_wind']
80
+
81
+ # Get magnetosheath data with southward IMF and high dynamic pressure
82
+ df = sm.get_data("magnetosheath", bz_imf_max=-2, pd_sw_min=3)
83
+
84
+ # Select specific columns and spacecraft
85
+ df = sm.get_data(
86
+ "magnetosphere",
87
+ columns=["X_gsm", "Y_gsm", "Z_gsm", "Np", "Bz"],
88
+ spacecraft=["MMS1", "THA"],
89
+ time_min="2015-01-01",
90
+ time_max="2020-12-31",
91
+ )
92
+
93
+ # List available filters for a region
94
+ sm.filters("magnetosheath")
95
+
96
+ # List columns
97
+ sm.columns("magnetosphere")
98
+ ```
99
+
100
+ ## Self-Hosting
101
+
102
+ ```bash
103
+ # Start the server (requires mango[server])
104
+ mango serve --data-dir /path/to/parquet/data
105
+
106
+ # Docker
107
+ ./docker/build.sh
108
+ docker run -d -p 8000:8000 -v /path/to/data:/data/mango:ro mango
109
+ ```
110
+
111
+ The server supports deployment behind a reverse proxy via `MANGO_ROOT_PATH`:
112
+
113
+ ```bash
114
+ docker run -d -p 8000:8000 \
115
+ -e MANGO_ROOT_PATH="/mango" \
116
+ -v /path/to/data:/data/mango:ro mango
117
+ ```
118
+
119
+
120
+
121
+ ## 📚 References
122
+
123
+ List of publications using the MANGO dataset:
124
+
125
+ ---
126
+
127
+ ### 🚀 2026
128
+
129
+ * **The MANGO dataset: Magnetospheric Atlas of Normalized Geospace Observations** **Michotte de Welle, B.**, Aunai, N., Ghisalberti, A., Lavraud, B., et al.
130
+ *In prep. for Nature Scientific Data*
131
+
132
+ ---
133
+
134
+ ### 🚀 2025
135
+
136
+ * **Statistical Estimate of the Magnetopause Reconnection Rate as a Function of the Interplanetary Magnetic Field Clock Angle** **Michotte de Welle, B.**, Aunai, N., Lavraud, B., et al.
137
+ *ESS Open Archive*, Septembre 2025.
138
+ [🔗 DOI: 10.22541/essoar.175745453.30048233/v1](https://doi.org/10.22541/essoar.175745453.30048233/v1)
139
+
140
+ * **A New X-Line Model: Comparison to MHD Magnetic Separator** **Michotte de Welle, B.**, Connor, H., Sibeck, D., Glocer, A., Fuselier, S., Trattner, K., Petrinec, S., Brenner, A., Bagheri, F., & Lee, S.
141
+ *Journal of Geophysical Research (Space Physics)*, 130(11).
142
+ [🔗 DOI: 10.1029/2025JA034558](https://doi.org/10.1029/2025JA034558) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2025JGRA..13034558M)
143
+
144
+ * **The Speed of Interplanetary Shocks Through the Magnetosheath: A Toy Model** Moissard, C., Butcher, C., Ruler, E., Richardson, J., **Michotte de Welle, B.**, Steward, W., Pritchard, M., et al.
145
+ *Geophysical Research Letters*, 52(7).
146
+ [🔗 DOI: 10.1029/2024GL113488](https://doi.org/10.1029/2024GL113488) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2025GeoRL..5213488M)
147
+
148
+ ---
149
+
150
+ ### 🛰️ 2024
151
+ * **Advanced Methods for Analyzing in-Situ Observations of Magnetic Reconnection** Hasegawa, H., Argall, M. R., Aunai, N., ..., **Michotte de Welle, B.**, ..., & Zenitani, S.
152
+ *Space Science Reviews*, 220(6).
153
+ [🔗 DOI: 10.1007/s11214-024-01095-w](https://doi.org/10.1007/s11214-024-01095-w) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024SSRv..220...68H)
154
+
155
+ * **Surface Charging of the Jupiter Icy Moons Explorer (JUICE) Spacecraft in the Solar Wind at 1 AU** Holmberg, M. K. G., Jackman, C. M., Taylor, M. G. G. T., Witasse, O., Wahlund, J.-E., Barabash, S., **Michotte de Welle, B.**, et al.
156
+ *Journal of Geophysical Research (Space Physics)*, 129(9).
157
+ [🔗 DOI: 10.1029/2023JA032137](https://doi.org/10.1029/2023JA032137) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024JGRA..12932137H)
158
+
159
+ * **Global Environmental Constraints on Magnetic Reconnection at the Magnetopause From In Situ Measurements** **Michotte de Welle, B.**, Aunai, N., Lavraud, B., Génot, V., Nguyen, G., Ghisalberti, A., Smets, R., & Jeandet, A.
160
+ *Journal of Geophysical Research (Space Physics)*, 129(8).
161
+ [🔗 DOI: 10.1029/2023JA032098](https://doi.org/10.1029/2023JA032098) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024JGRA..12932098M)
162
+
163
+ * **Spatial distribution of plasma density and magnetic field amplitude in the dayside magnetosheath as a function of the IMF orientation** **Michotte de Welle, B.**, Aunai, N., Lavraud, B., Génot, V., Jeandet, A., Nguyen, G., Ghisalberti, A., & Smets, R.
164
+ *Frontiers in Astronomy and Space Sciences*, 11.
165
+ [🔗 DOI: 10.3389/fspas.2024.1427791](https://doi.org/10.3389/fspas.2024.1427791) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024FrASS..1127791M)
166
+
167
+ ---
168
+
169
+ ### 🔍 2022
170
+
171
+ #### Massive Multi-Mission Statistical Study and Analytical Modeling of the Earth's Magnetopause:
172
+
173
+ 1. **Part 1: A Gradient Boosting Based Automatic Detection of Near-Earth Regions** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA029773](https://doi.org/10.1029/2021JA029773)
174
+ 2. **Part 2: Shape and Location** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA029774](https://doi.org/10.1029/2021JA029774)
175
+ 3. **Part 3: An Asymmetric Non Indented Magnetopause Analytical Model** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA030112](https://doi.org/10.1029/2021JA030112)
176
+ 4. **Part 4: On the Near-Cusp Magnetopause Indentation** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA029776](https://doi.org/10.1029/2021JA029776)
177
+
178
+ #### Others
179
+
180
+ * **Global Three-Dimensional Draping of Magnetic Field Lines in Earth's Magnetosheath** **Michotte de Welle, B.**, Aunai, N., Nguyen, G., Lavraud, B., Génot, V., et al.
181
+ *Journal of Geophysical Research (Space Physics)*, 127(12).
182
+ [🔗 DOI: 10.1029/2022JA030996](https://doi.org/10.1029/2022JA030996) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2022JGRA..12730996M)
183
+
184
+
@@ -0,0 +1,154 @@
1
+
2
+ # MANGO: Magnetospheric Atlas of Normalized Geospace Observations
3
+
4
+ <img width="300" height="300" alt="mangologo" src="https://github.com/user-attachments/assets/5a92150f-ce77-45a8-b15e-8f66ff7cf44b" />
5
+
6
+
7
+ ## Overview
8
+
9
+ **MANGO** is a dataset and Python toolkit for the global analysis of Earth's magnetosphere.
10
+ Unlike raw satellite observations, MANGO provides a **unified, classified, and spatially normalized** view of geospace,
11
+ where each datapoint is contextualized by its magnetospheric region and upstream solar wind conditions and
12
+ repositioned relative to dynamic boundaries like the magnetopause and bow shock.
13
+
14
+ By accounting for the dynamic nature of magnetospheric boundaries,
15
+ MANGO allows researchers to treat disparate satellite observations as part of a single, coherent atlas.
16
+
17
+ ## Key Features
18
+
19
+ Every data point in the MANGO dataset is:
20
+ * **Classified:** Labeled by its specific magnetospheric region (magnetosphere, magnetosheath, solar wind).
21
+ * **Contextualized:** Associated with the causal upstream solar wind conditions retrieved from OMNI data.
22
+ * **Normalized:** Repositioned spatially relative to dynamic boundaries (the bow shock and magnetopause).
23
+
24
+ The Python package provides:
25
+ * A **client** for querying the public MANGO server — returns [Polars](https://pola.rs) DataFrames via Arrow IPC.
26
+ * A **server** (optional) for self-hosting the dataset with FastAPI.
27
+ * **Data-driven filter catalog** — range filters on IMF, solar wind, spatial coordinates, and local plasma parameters.
28
+
29
+
30
+ ---
31
+
32
+ ## Installation
33
+
34
+ ```bash
35
+ # Client only (query the public server)
36
+ pip install space-mango
37
+
38
+ # With server dependencies (self-hosting)
39
+ pip install space-mango[server]
40
+ ```
41
+
42
+ ## Quick Start
43
+
44
+ ```python
45
+ import space_mango as sm
46
+
47
+ # List available regions
48
+ sm.regions()
49
+ # ['magnetosphere', 'magnetosheath', 'solar_wind']
50
+
51
+ # Get magnetosheath data with southward IMF and high dynamic pressure
52
+ df = sm.get_data("magnetosheath", bz_imf_max=-2, pd_sw_min=3)
53
+
54
+ # Select specific columns and spacecraft
55
+ df = sm.get_data(
56
+ "magnetosphere",
57
+ columns=["X_gsm", "Y_gsm", "Z_gsm", "Np", "Bz"],
58
+ spacecraft=["MMS1", "THA"],
59
+ time_min="2015-01-01",
60
+ time_max="2020-12-31",
61
+ )
62
+
63
+ # List available filters for a region
64
+ sm.filters("magnetosheath")
65
+
66
+ # List columns
67
+ sm.columns("magnetosphere")
68
+ ```
69
+
70
+ ## Self-Hosting
71
+
72
+ ```bash
73
+ # Start the server (requires mango[server])
74
+ mango serve --data-dir /path/to/parquet/data
75
+
76
+ # Docker
77
+ ./docker/build.sh
78
+ docker run -d -p 8000:8000 -v /path/to/data:/data/mango:ro mango
79
+ ```
80
+
81
+ The server supports deployment behind a reverse proxy via `MANGO_ROOT_PATH`:
82
+
83
+ ```bash
84
+ docker run -d -p 8000:8000 \
85
+ -e MANGO_ROOT_PATH="/mango" \
86
+ -v /path/to/data:/data/mango:ro mango
87
+ ```
88
+
89
+
90
+
91
+ ## 📚 References
92
+
93
+ List of publications using the MANGO dataset:
94
+
95
+ ---
96
+
97
+ ### 🚀 2026
98
+
99
+ * **The MANGO dataset: Magnetospheric Atlas of Normalized Geospace Observations** **Michotte de Welle, B.**, Aunai, N., Ghisalberti, A., Lavraud, B., et al.
100
+ *In prep. for Nature Scientific Data*
101
+
102
+ ---
103
+
104
+ ### 🚀 2025
105
+
106
+ * **Statistical Estimate of the Magnetopause Reconnection Rate as a Function of the Interplanetary Magnetic Field Clock Angle** **Michotte de Welle, B.**, Aunai, N., Lavraud, B., et al.
107
+ *ESS Open Archive*, Septembre 2025.
108
+ [🔗 DOI: 10.22541/essoar.175745453.30048233/v1](https://doi.org/10.22541/essoar.175745453.30048233/v1)
109
+
110
+ * **A New X-Line Model: Comparison to MHD Magnetic Separator** **Michotte de Welle, B.**, Connor, H., Sibeck, D., Glocer, A., Fuselier, S., Trattner, K., Petrinec, S., Brenner, A., Bagheri, F., & Lee, S.
111
+ *Journal of Geophysical Research (Space Physics)*, 130(11).
112
+ [🔗 DOI: 10.1029/2025JA034558](https://doi.org/10.1029/2025JA034558) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2025JGRA..13034558M)
113
+
114
+ * **The Speed of Interplanetary Shocks Through the Magnetosheath: A Toy Model** Moissard, C., Butcher, C., Ruler, E., Richardson, J., **Michotte de Welle, B.**, Steward, W., Pritchard, M., et al.
115
+ *Geophysical Research Letters*, 52(7).
116
+ [🔗 DOI: 10.1029/2024GL113488](https://doi.org/10.1029/2024GL113488) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2025GeoRL..5213488M)
117
+
118
+ ---
119
+
120
+ ### 🛰️ 2024
121
+ * **Advanced Methods for Analyzing in-Situ Observations of Magnetic Reconnection** Hasegawa, H., Argall, M. R., Aunai, N., ..., **Michotte de Welle, B.**, ..., & Zenitani, S.
122
+ *Space Science Reviews*, 220(6).
123
+ [🔗 DOI: 10.1007/s11214-024-01095-w](https://doi.org/10.1007/s11214-024-01095-w) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024SSRv..220...68H)
124
+
125
+ * **Surface Charging of the Jupiter Icy Moons Explorer (JUICE) Spacecraft in the Solar Wind at 1 AU** Holmberg, M. K. G., Jackman, C. M., Taylor, M. G. G. T., Witasse, O., Wahlund, J.-E., Barabash, S., **Michotte de Welle, B.**, et al.
126
+ *Journal of Geophysical Research (Space Physics)*, 129(9).
127
+ [🔗 DOI: 10.1029/2023JA032137](https://doi.org/10.1029/2023JA032137) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024JGRA..12932137H)
128
+
129
+ * **Global Environmental Constraints on Magnetic Reconnection at the Magnetopause From In Situ Measurements** **Michotte de Welle, B.**, Aunai, N., Lavraud, B., Génot, V., Nguyen, G., Ghisalberti, A., Smets, R., & Jeandet, A.
130
+ *Journal of Geophysical Research (Space Physics)*, 129(8).
131
+ [🔗 DOI: 10.1029/2023JA032098](https://doi.org/10.1029/2023JA032098) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024JGRA..12932098M)
132
+
133
+ * **Spatial distribution of plasma density and magnetic field amplitude in the dayside magnetosheath as a function of the IMF orientation** **Michotte de Welle, B.**, Aunai, N., Lavraud, B., Génot, V., Jeandet, A., Nguyen, G., Ghisalberti, A., & Smets, R.
134
+ *Frontiers in Astronomy and Space Sciences*, 11.
135
+ [🔗 DOI: 10.3389/fspas.2024.1427791](https://doi.org/10.3389/fspas.2024.1427791) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2024FrASS..1127791M)
136
+
137
+ ---
138
+
139
+ ### 🔍 2022
140
+
141
+ #### Massive Multi-Mission Statistical Study and Analytical Modeling of the Earth's Magnetopause:
142
+
143
+ 1. **Part 1: A Gradient Boosting Based Automatic Detection of Near-Earth Regions** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA029773](https://doi.org/10.1029/2021JA029773)
144
+ 2. **Part 2: Shape and Location** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA029774](https://doi.org/10.1029/2021JA029774)
145
+ 3. **Part 3: An Asymmetric Non Indented Magnetopause Analytical Model** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA030112](https://doi.org/10.1029/2021JA030112)
146
+ 4. **Part 4: On the Near-Cusp Magnetopause Indentation** Nguyen, G., Aunai, N., **Michotte de Welle, B.**, et al. [🔗 DOI: 10.1029/2021JA029776](https://doi.org/10.1029/2021JA029776)
147
+
148
+ #### Others
149
+
150
+ * **Global Three-Dimensional Draping of Magnetic Field Lines in Earth's Magnetosheath** **Michotte de Welle, B.**, Aunai, N., Nguyen, G., Lavraud, B., Génot, V., et al.
151
+ *Journal of Geophysical Research (Space Physics)*, 127(12).
152
+ [🔗 DOI: 10.1029/2022JA030996](https://doi.org/10.1029/2022JA030996) | [🌌 ADS](https://ui.adsabs.harvard.edu/abs/2022JGRA..12730996M)
153
+
154
+