| Name | mpmaps JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | magnetopause maps |
| upload_time | 2024-05-09 14:53:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
space
plasma-physics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Magnetopause Maps
[](https://pypi.python.org/pypi/mpmaps)
[](https://github.com/LaboratoryOfPlasmaPhysics/mpmaps/actions/workflows/test_main.yml)
[](https://mpmaps.readthedocs.io/en/latest/?badge=latest)
[](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/mpmaps/branch/main)
MMPaps is a package that allows to compute and plot maps of various physical quantities onto the
Earth Magnetopause. Maps are computed from in situ measurements only, following the methodology of
Michotte de Welle et al. 2004
```
@article{MichottedeWelle2024,
title={Global environmental constraints on magnetic reconnection at the magnetopause from in-situ measurements},
DOI={10.22541/essoar.170808382.29449499/v1},
journal={ESS Open Archive},
author={Michotte de Welle, B and Aunai, N and Lavraud, B. and Nguyen, G. and Génot, V and Ghisalberti, A. and Jeandet, A. and Smets, R.},
year={2024}}
```
* Free software: GNU General Public License v3
* Documentation: https://mpmaps.readthedocs.io.
## Features
### compute a shear angle map
```python
import mpmaps
mpm = mpmaps.MPMap()
# set IMF parameters
mpm.set_parameters(tilt=12, clock=127, cone = 22, bimf=5)
# compute and retrieve shear angle values for
# parameters set above
shear_map_values = mpm.shear_angle()
# now let's make a map for northward IMF
# other IMF params are default ones
mpm_north = mpm.MPMap(clock=45)
shear = mpm_north.shear_angle()
```
### compute reconnection rate map
```python
import mpmaps
mpm = mpmaps.MPMap()
# set IMF parameters
mpm.set_parameters(tilt=12, clock=127, cone = 22, bimf=5)
# compute and retrieve rate values for
# parameters set above
# by default the reconnection components are computed
# so that the X line maximizes the Cassak-Shay scaliing law
# (rec_angle='rate')
rate_values = mpm.reconnection_rate()
#now same map but with X line locally aligned with the bisection
rate_values_bisec = mpm.reconnection_rate(rec_angle='bisection')
```
### compute the current density map
```python
import mpmaps
mpm = mpmaps.MPMap()
# set IMF parameters
mpm.set_parameters(tilt=12, clock=127, cone = 22, bimf=5)
values = mpm.current_density()
# default magnetopause thickness is 800km
# but can be changed
mpm.set_parameters(mp_thick=800)
values = mpm.current_density()
```
## Credits
We acknowledge support from:
- The space plasma team of the [Laboratory of Plasma Physics](https://www.lpp.polytechnique.fr)
Raw data
{
"_id": null,
"home_page": null,
"name": "mpmaps",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "Bayane Michotte de Welle <bayane.michotte-de-welle@lpp.polytechnique.fr>, Nicolas Aunai <nicolas.aunai@lpp.polytechnique.fr>",
"keywords": "space, plasma-physics",
"author": null,
"author_email": "Bayane Michotte de Welle <bayane.michotte-de-welle@lpp.polytechnique.fr>, Nicolas Aunai <nicolas.aunai@lpp.polytechnique.fr>",
"download_url": "https://files.pythonhosted.org/packages/00/ba/50dce27d2e2464259b2a3fefd9f3d1adf70eeef088574f44f59515c7f5ed/mpmaps-0.2.0.tar.gz",
"platform": null,
"description": "\n\n\n# Magnetopause Maps\n\n[](https://pypi.python.org/pypi/mpmaps)\n[](https://github.com/LaboratoryOfPlasmaPhysics/mpmaps/actions/workflows/test_main.yml)\n[](https://mpmaps.readthedocs.io/en/latest/?badge=latest)\n[](https://codecov.io/gh/LaboratoryOfPlasmaPhysics/mpmaps/branch/main)\n\nMMPaps is a package that allows to compute and plot maps of various physical quantities onto the\nEarth Magnetopause. Maps are computed from in situ measurements only, following the methodology of\nMichotte de Welle et al. 2004\n\n\n```\n@article{MichottedeWelle2024,\ntitle={Global environmental constraints on magnetic reconnection at the magnetopause from in-situ measurements},\nDOI={10.22541/essoar.170808382.29449499/v1},\njournal={ESS Open Archive},\nauthor={Michotte de Welle, B and Aunai, N and Lavraud, B. and Nguyen, G. and G\u00e9not, V and Ghisalberti, A. and Jeandet, A. and Smets, R.},\nyear={2024}}\n```\n\n\n* Free software: GNU General Public License v3\n* Documentation: https://mpmaps.readthedocs.io.\n\n## Features\n\n### compute a shear angle map\n```python\nimport mpmaps\nmpm = mpmaps.MPMap()\n\n# set IMF parameters\nmpm.set_parameters(tilt=12, clock=127, cone = 22, bimf=5)\n\n# compute and retrieve shear angle values for\n# parameters set above\nshear_map_values = mpm.shear_angle()\n\n# now let's make a map for northward IMF\n# other IMF params are default ones\nmpm_north = mpm.MPMap(clock=45)\nshear = mpm_north.shear_angle()\n\n```\n\n### compute reconnection rate map\n\n\n```python\nimport mpmaps\nmpm = mpmaps.MPMap()\n\n# set IMF parameters\nmpm.set_parameters(tilt=12, clock=127, cone = 22, bimf=5)\n\n# compute and retrieve rate values for\n# parameters set above\n# by default the reconnection components are computed\n# so that the X line maximizes the Cassak-Shay scaliing law\n# (rec_angle='rate')\nrate_values = mpm.reconnection_rate()\n\n#now same map but with X line locally aligned with the bisection\nrate_values_bisec = mpm.reconnection_rate(rec_angle='bisection')\n\n```\n\n\n### compute the current density map\n\n```python\n\nimport mpmaps\nmpm = mpmaps.MPMap()\n\n# set IMF parameters\nmpm.set_parameters(tilt=12, clock=127, cone = 22, bimf=5)\n\nvalues = mpm.current_density()\n\n\n# default magnetopause thickness is 800km\n# but can be changed\nmpm.set_parameters(mp_thick=800)\nvalues = mpm.current_density()\n```\n\n\n\n## Credits\n\nWe acknowledge support from:\n\n- The space plasma team of the [Laboratory of Plasma Physics](https://www.lpp.polytechnique.fr)\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "magnetopause maps",
"version": "0.2.0",
"project_urls": {
"homepage": "https://github.com/LaboratoryOfPlasmaPhysics/mpmaps"
},
"split_keywords": [
"space",
" plasma-physics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eb93b4796d2c8729c339b9fd42a1d28b78834f3377e83f00ebc99de8b7cbc3b9",
"md5": "be686f219a3cc054cd8e4c00aa197414",
"sha256": "718539d26eaf2b04987e6844983ef212ddf8faad40fe9f4584d6a1074e6af005"
},
"downloads": -1,
"filename": "mpmaps-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be686f219a3cc054cd8e4c00aa197414",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7313,
"upload_time": "2024-05-09T14:53:01",
"upload_time_iso_8601": "2024-05-09T14:53:01.172186Z",
"url": "https://files.pythonhosted.org/packages/eb/93/b4796d2c8729c339b9fd42a1d28b78834f3377e83f00ebc99de8b7cbc3b9/mpmaps-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "00ba50dce27d2e2464259b2a3fefd9f3d1adf70eeef088574f44f59515c7f5ed",
"md5": "ffde5aa697178057a070873692df850b",
"sha256": "7e5d9f60e888b50cdc29454898be21b39a3c044a599aa7fbf7cdacb2bbc82911"
},
"downloads": -1,
"filename": "mpmaps-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ffde5aa697178057a070873692df850b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6524,
"upload_time": "2024-05-09T14:53:03",
"upload_time_iso_8601": "2024-05-09T14:53:03.014526Z",
"url": "https://files.pythonhosted.org/packages/00/ba/50dce27d2e2464259b2a3fefd9f3d1adf70eeef088574f44f59515c7f5ed/mpmaps-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 14:53:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "LaboratoryOfPlasmaPhysics",
"github_project": "mpmaps",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mpmaps"
}
