| Name | plasmapy JSON |
| Version |
2024.10.0
JSON |
| download |
| home_page | None |
| Summary | Python package for plasma science |
| upload_time | 2024-10-30 00:34:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause License Copyright (c) 2015–2024, PlasmaPy Developers. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of PlasmaPy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. |
| keywords |
astronomy
fusion
heliophysics
plasma
plasma physics
science
solar physics
space plasmas
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center"><img src="https://raw.githubusercontent.com/PlasmaPy/PlasmaPy-logo/main/exports/with-text-dark.png" width="600"/></div>
# PlasmaPy
[](https://pypi.org/project/plasmapy/)
[](https://img.shields.io/conda/v/conda-forge/plasmapy)
[](https://img.shields.io/pypi/pyversions/plasmapy?style=plastic)
[](./LICENSE.md)
[](https://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html)
[](https://app.element.io/#/room/#plasmapy:openastronomy.org)
<a rel="me" href="https://fosstodon.org/@plasmapy"></a>
[](https://www.youtube.com/channel/UCSH6qzslhqIZKTAJmHPxIxw)
[](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/ci.yml)
[](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/weekly.yml)
[](https://results.pre-commit.ci/latest/github/PlasmaPy/PlasmaPy/main)
[](https://codecov.io/gh/PlasmaPy/PlasmaPy)
[](http://plasmapy.readthedocs.io/en/latest/?badge=latest)
[](https://doi.org/10.5281/zenodo.1436011)
[](http://www.astropy.org/)
[](https://github.com/pre-commit/pre-commit)
[Astropy]: https://www.astropy.org
[authors and credits]: https://docs.plasmapy.org/en/latest/about/credits.html
[3-clause BSD license]: ./LICENSE.md
[calendar]: https://calendar.google.com/calendar/embed?src=c_sqqq390s24jjfjp3q86pv41pi8%40group.calendar.google.com&ctz=America%2FNew_York
[cite PlasmaPy]: https://docs.plasmapy.org/en/latest/about/citation.html
[code of conduct]: http://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html
[community meetings]: https://www.plasmapy.org/meetings/weekly
[contributor guide]: https://docs.plasmapy.org/en/latest/development/index.html
[Department of Energy]: https://www.energy.gov
[example gallery]: https://docs.plasmapy.org/en/stable/examples.html
[GitHub discussions]: https://github.com/PlasmaPy/PlasmaPy/discussions
[Gitter]: https://gitter.im/PlasmaPy/Lobby
[good first issues]: https://github.com/PlasmaPy/PlasmaPy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[Google Summer of Code]: https://summerofcode.withgoogle.com
[**install PlasmaPy**]: https://docs.plasmapy.org/en/stable/install.html
[GitHub repository]: https://github.com/PlasmaPy/PlasmaPy
[mailing list]: https://groups.google.com/forum/#!forum/plasmapy
[Matrix]: https://app.element.io/#/room/#plasmapy:openastronomy.org
[meetings]: https://www.plasmapy.org/meetings/weekly
[NASA]: https://www.nasa.gov/
[National Science Foundation]: https://nsf.gov
[office hours]: http://www.plasmapy.org/meetings/office_hours
[PlasmaPy Community on Zenodo]: https://zenodo.org/communities/plasmapy
[PlasmaPy]: https://www.plasmapy.org
[**documentation**]: https://docs.plasmapy.org
[protections against software patents]: ./PATENT.md
[Python]: https://www.python.org
[Smithsonian Institution]: https://www.si.edu
[submit a bug report]: https://github.com/PlasmaPy/PlasmaPy/issues/new?assignees=&labels=Bug&template=bug_report.yml
[submit a feature request]: https://github.com/PlasmaPy/PlasmaPy/issues/new?assignees=&labels=Feature+request&template=feature_request.yml
[team@plasmapy.org]: mailto:team@plasmapy.org
[this video]: https://youtu.be/E8RwQF5wcXM
[Zoom]: https://zoom.us/j/91633383503?pwd=QWNkdHpWeFhrYW1vQy91ODNTVG5Ndz09
[PlasmaPy] is an open source, community-developed [Python] package for
plasma research and education. PlasmaPy intends to be for plasma
science what [Astropy] is for astronomy — a collection of
functionality commonly needed by plasma scientists and researchers
globally, running within and leveraging the open source scientific
Python ecosystem. The goals of PlasmaPy are more thoroughly described
in [this video]. Many of our recent presentations are available from
the [PlasmaPy Community on Zenodo].
## Documentation
Please check out our online [**documentation**] to learn more about
PlasmaPy's capabilities.
If you would like an idea of what PlasmaPy can do, go to our [example
gallery] of Jupyter notebooks. To learn more about how to contribute,
check out PlasmaPy's [contributor guide].
## Installing PlasmaPy
PlasmaPy's online documentation has detailed instructions on how to
[**install PlasmaPy**].
To install PlasmaPy on macOS or Linux, open a terminal and run:
```Shell
python -m pip install plasmapy
```
> [!NOTE]
> On some systems, it might be necessary to specify the Python version
> number, for example by using `python3` or `python3.13` instead of
> `python`.
To install PlasmaPy on Windows, open a terminal and run
```Shell
py -3.13 -m pip install plasmapy
```
The `3.13` may be replaced by any version of Python that is installed
and supported by PlasmaPy.
## Citing PlasmaPy
If you use PlasmaPy for research resulting in a publication, please
[cite PlasmaPy]. It really helps support the project! Citing software
used in research provides credit to its authors, promotes open science &
scientific reproducibility, and helps open source projects demonstrate
to funding agencies that continued development should be supported.
Please check out the [PlasmaPy community on Zenodo] for prior releases
of PlasmaPy and other resources.
## Requesting features
Please [submit a feature request] in our [GitHub repository] if you
have an idea for new or improved functionality. PlasmaPy is
community-driven, and feature requests really help guide the future of
the project.
## Submitting bug reports
Please [submit a bug report] on PlasmaPy's GitHub repository if you
notice any problems. We really appreciate it!
## Contributing
If you are interested in contributing, please check out our [contributor
guide] and [code of conduct]. There are a number of [good first issues]
in our GitHub repository. New contributors are very welcome!
## Events
PlasmaPy has several [meetings] that are on our [calendar]. Events are
usually held on PlasmaPy's [Zoom] room.
Last-minute changes are usually announced on the [Matrix]/[Gitter]
chat room. The most up-to-date information about these meetings is on
the [meetings] page of PlasmaPy's website.
### Office hours
Our weekly informal [office hours] are an opportunity to chat with
active members of the PlasmaPy community about topics related to
Python and plasma science. If you'd like to learn more about PlasmaPy,
our office hours are one of the best places to start. As of July
2024, our office hours are on most Thursdays at 3 pm Eastern. Please
feel free to come by!
### Community meetings
PlasmaPy's weekly [community meetings] are a place to talk about code
development. If you have an idea for a new feature or would like to
make a code contribution, community meetings are a good place to go
to. As of July 2024, our community meetings are on most Tuesdays at 2 pm
Eastern.
<!--
### Project meetings
PlasmaPy's weekly project meetings are a place to discuss education,
outreach, and project coordination. Topics might range from creating
educational notebooks to organizing community events. As of July
2024, project meetings are held on most Wednesdays at 3 pm Eastern.
-->
<!--
### Working group meetings
PlasmaPy has started several working groups, including on diagnostics,
dispersion relations, and simulation. These working groups usually
meet fortnightly, and their meeting times can be found in PlasmaPy's
event [calendar]. If you would like to join a PlasmaPy working group
or even start a new one, please email us at [team@plasmapy.org]!
-->
## Community
### Matrix chat
If you have any questions, the quickest way to get a response is to
ask on our [Matrix]/[Gitter] channel. Both of these are the same chat
channel; Gitter uses a bridge to link the two.
### GitHub discussions
We're trying out [GitHub discussions] as a place to suggest ideas,
bring up discussion topics, and ask questions.
### Mailing list
You can subscribe to PlasmaPy's low-volume [mailing list] to receive
PlasmaPy newsletters and other announcements.
## Contact information
Please feel free to reach out to us at [team@plasmapy.org] or stop by
our [office hours] with any ideas, questions, and/or puns about
computational magnetohydrodynamics.
Please use these links to [submit a feature request] and to [submit a
bug report] on PlasmaPy's GitHub repository.
## License
PlasmaPy is permissively licensed under a [3-clause BSD license] with
added [protections against software patents].
## Acknowledgments
Development of PlasmaPy has been supported in part by the [National
Science Foundation], [Department of Energy], [NASA], and the
[Smithsonian Institution]. For more details, please see PlasmaPy's
documentation page on [authors and credits].
Raw data
{
"_id": null,
"home_page": null,
"name": "plasmapy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "astronomy, fusion, heliophysics, plasma, plasma physics, science, solar physics, space plasmas",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/2d/2a/0ef20f8b8e75e537199608b68cd7e5750885195b09ddbc55d1a6075fa28f/plasmapy-2024.10.0.tar.gz",
"platform": null,
"description": "<div align=\"center\"><img src=\"https://raw.githubusercontent.com/PlasmaPy/PlasmaPy-logo/main/exports/with-text-dark.png\" width=\"600\"/></div>\n\n# PlasmaPy\n\n[](https://pypi.org/project/plasmapy/)\n[](https://img.shields.io/conda/v/conda-forge/plasmapy)\n[](https://img.shields.io/pypi/pyversions/plasmapy?style=plastic)\n[](./LICENSE.md)\n[](https://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html)\n\n[](https://app.element.io/#/room/#plasmapy:openastronomy.org)\n<a rel=\"me\" href=\"https://fosstodon.org/@plasmapy\"></a>\n[](https://www.youtube.com/channel/UCSH6qzslhqIZKTAJmHPxIxw)\n\n[](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/ci.yml)\n[](https://github.com/PlasmaPy/PlasmaPy/actions/workflows/weekly.yml)\n[](https://results.pre-commit.ci/latest/github/PlasmaPy/PlasmaPy/main)\n[](https://codecov.io/gh/PlasmaPy/PlasmaPy)\n[](http://plasmapy.readthedocs.io/en/latest/?badge=latest)\n\n[](https://doi.org/10.5281/zenodo.1436011)\n[](http://www.astropy.org/)\n[](https://github.com/pre-commit/pre-commit)\n\n[Astropy]: https://www.astropy.org\n[authors and credits]: https://docs.plasmapy.org/en/latest/about/credits.html\n[3-clause BSD license]: ./LICENSE.md\n[calendar]: https://calendar.google.com/calendar/embed?src=c_sqqq390s24jjfjp3q86pv41pi8%40group.calendar.google.com&ctz=America%2FNew_York\n[cite PlasmaPy]: https://docs.plasmapy.org/en/latest/about/citation.html\n[code of conduct]: http://docs.plasmapy.org/en/latest/CODE_OF_CONDUCT.html\n[community meetings]: https://www.plasmapy.org/meetings/weekly\n[contributor guide]: https://docs.plasmapy.org/en/latest/development/index.html\n[Department of Energy]: https://www.energy.gov\n[example gallery]: https://docs.plasmapy.org/en/stable/examples.html\n[GitHub discussions]: https://github.com/PlasmaPy/PlasmaPy/discussions\n[Gitter]: https://gitter.im/PlasmaPy/Lobby\n[good first issues]: https://github.com/PlasmaPy/PlasmaPy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22\n[Google Summer of Code]: https://summerofcode.withgoogle.com\n[**install PlasmaPy**]: https://docs.plasmapy.org/en/stable/install.html\n[GitHub repository]: https://github.com/PlasmaPy/PlasmaPy\n[mailing list]: https://groups.google.com/forum/#!forum/plasmapy\n[Matrix]: https://app.element.io/#/room/#plasmapy:openastronomy.org\n[meetings]: https://www.plasmapy.org/meetings/weekly\n[NASA]: https://www.nasa.gov/\n[National Science Foundation]: https://nsf.gov\n[office hours]: http://www.plasmapy.org/meetings/office_hours\n[PlasmaPy Community on Zenodo]: https://zenodo.org/communities/plasmapy\n[PlasmaPy]: https://www.plasmapy.org\n[**documentation**]: https://docs.plasmapy.org\n[protections against software patents]: ./PATENT.md\n[Python]: https://www.python.org\n[Smithsonian Institution]: https://www.si.edu\n[submit a bug report]: https://github.com/PlasmaPy/PlasmaPy/issues/new?assignees=&labels=Bug&template=bug_report.yml\n[submit a feature request]: https://github.com/PlasmaPy/PlasmaPy/issues/new?assignees=&labels=Feature+request&template=feature_request.yml\n[team@plasmapy.org]: mailto:team@plasmapy.org\n[this video]: https://youtu.be/E8RwQF5wcXM\n[Zoom]: https://zoom.us/j/91633383503?pwd=QWNkdHpWeFhrYW1vQy91ODNTVG5Ndz09\n\n[PlasmaPy] is an open source, community-developed [Python] package for\nplasma research and education. PlasmaPy intends to be for plasma\nscience what [Astropy] is for astronomy \u2014 a collection of\nfunctionality commonly needed by plasma scientists and researchers\nglobally, running within and leveraging the open source scientific\nPython ecosystem. The goals of PlasmaPy are more thoroughly described\nin [this video]. Many of our recent presentations are available from\nthe [PlasmaPy Community on Zenodo].\n\n## Documentation\n\nPlease check out our online [**documentation**] to learn more about\nPlasmaPy's capabilities.\n\nIf you would like an idea of what PlasmaPy can do, go to our [example\ngallery] of Jupyter notebooks. To learn more about how to contribute,\ncheck out PlasmaPy's [contributor guide].\n\n## Installing PlasmaPy\n\nPlasmaPy's online documentation has detailed instructions on how to\n[**install PlasmaPy**].\n\nTo install PlasmaPy on macOS or Linux, open a terminal and run:\n```Shell\npython -m pip install plasmapy\n```\n\n> [!NOTE]\n> On some systems, it might be necessary to specify the Python version\n> number, for example by using `python3` or `python3.13` instead of\n> `python`.\n\nTo install PlasmaPy on Windows, open a terminal and run\n```Shell\npy -3.13 -m pip install plasmapy\n```\nThe `3.13` may be replaced by any version of Python that is installed\nand supported by PlasmaPy.\n\n## Citing PlasmaPy\n\nIf you use PlasmaPy for research resulting in a publication, please\n[cite PlasmaPy]. It really helps support the project! Citing software\nused in research provides credit to its authors, promotes open science &\nscientific reproducibility, and helps open source projects demonstrate\nto funding agencies that continued development should be supported.\n\nPlease check out the [PlasmaPy community on Zenodo] for prior releases\nof PlasmaPy and other resources.\n\n## Requesting features\n\nPlease [submit a feature request] in our [GitHub repository] if you\nhave an idea for new or improved functionality. PlasmaPy is\ncommunity-driven, and feature requests really help guide the future of\nthe project.\n\n## Submitting bug reports\n\nPlease [submit a bug report] on PlasmaPy's GitHub repository if you\nnotice any problems. We really appreciate it!\n\n## Contributing\n\nIf you are interested in contributing, please check out our [contributor\nguide] and [code of conduct]. There are a number of [good first issues]\nin our GitHub repository. New contributors are very welcome!\n\n## Events\n\nPlasmaPy has several [meetings] that are on our [calendar]. Events are\nusually held on PlasmaPy's [Zoom] room.\n\nLast-minute changes are usually announced on the [Matrix]/[Gitter]\nchat room. The most up-to-date information about these meetings is on\nthe [meetings] page of PlasmaPy's website.\n\n### Office hours\n\nOur weekly informal [office hours] are an opportunity to chat with\nactive members of the PlasmaPy community about topics related to\nPython and plasma science. If you'd like to learn more about PlasmaPy,\nour office hours are one of the best places to start. As of July\n2024, our office hours are on most Thursdays at 3 pm Eastern. Please\nfeel free to come by!\n\n### Community meetings\n\nPlasmaPy's weekly [community meetings] are a place to talk about code\ndevelopment. If you have an idea for a new feature or would like to\nmake a code contribution, community meetings are a good place to go\nto. As of July 2024, our community meetings are on most Tuesdays at 2 pm\nEastern.\n\n<!--\n### Project meetings\n\nPlasmaPy's weekly project meetings are a place to discuss education,\noutreach, and project coordination. Topics might range from creating\neducational notebooks to organizing community events. As of July\n2024, project meetings are held on most Wednesdays at 3 pm Eastern.\n-->\n\n<!--\n### Working group meetings\n\nPlasmaPy has started several working groups, including on diagnostics,\ndispersion relations, and simulation. These working groups usually\nmeet fortnightly, and their meeting times can be found in PlasmaPy's\nevent [calendar]. If you would like to join a PlasmaPy working group\nor even start a new one, please email us at [team@plasmapy.org]!\n-->\n\n## Community\n\n### Matrix chat\n\nIf you have any questions, the quickest way to get a response is to\nask on our [Matrix]/[Gitter] channel. Both of these are the same chat\nchannel; Gitter uses a bridge to link the two.\n\n### GitHub discussions\n\nWe're trying out [GitHub discussions] as a place to suggest ideas,\nbring up discussion topics, and ask questions.\n\n### Mailing list\n\nYou can subscribe to PlasmaPy's low-volume [mailing list] to receive\nPlasmaPy newsletters and other announcements.\n\n## Contact information\n\nPlease feel free to reach out to us at [team@plasmapy.org] or stop by\nour [office hours] with any ideas, questions, and/or puns about\ncomputational magnetohydrodynamics.\n\nPlease use these links to [submit a feature request] and to [submit a\nbug report] on PlasmaPy's GitHub repository.\n\n## License\n\nPlasmaPy is permissively licensed under a [3-clause BSD license] with\nadded [protections against software patents].\n\n## Acknowledgments\n\nDevelopment of PlasmaPy has been supported in part by the [National\nScience Foundation], [Department of Energy], [NASA], and the\n[Smithsonian Institution]. For more details, please see PlasmaPy's\ndocumentation page on [authors and credits].\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2015\u20132024, PlasmaPy Developers. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of PlasmaPy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. This software is provided by the copyright holders and contributors \"as is\" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. ",
"summary": "Python package for plasma science",
"version": "2024.10.0",
"project_urls": {
"Changelog": "https://docs.plasmapy.org/en/stable/whatsnew/index.html",
"Chat": "https://plasmapy.org/chat",
"Documentation": "https://docs.plasmapy.org/",
"Issues": "https://github.com/PlasmaPy/plasmapy/issues/",
"Source": "https://github.com/PlasmaPy/plasmapy",
"website": "https://www.plasmapy.org"
},
"split_keywords": [
"astronomy",
" fusion",
" heliophysics",
" plasma",
" plasma physics",
" science",
" solar physics",
" space plasmas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96d0570d21e14db075de44b98b6eaa398139461e336d36ef43bdfcc1bf52f1f7",
"md5": "b372c9691eaf303f513d37176fce1757",
"sha256": "b5e6500844804891b278b8894588232e5fa24b3670f527f52dd1a3c1d225b44e"
},
"downloads": -1,
"filename": "plasmapy-2024.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b372c9691eaf303f513d37176fce1757",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8681283,
"upload_time": "2024-10-30T00:34:32",
"upload_time_iso_8601": "2024-10-30T00:34:32.108691Z",
"url": "https://files.pythonhosted.org/packages/96/d0/570d21e14db075de44b98b6eaa398139461e336d36ef43bdfcc1bf52f1f7/plasmapy-2024.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d2a0ef20f8b8e75e537199608b68cd7e5750885195b09ddbc55d1a6075fa28f",
"md5": "c9c315a4b50cea2875f6d554d30f89aa",
"sha256": "5219148202c146e8fc1e14b8707a7e8ca44224a231070643fec4c0fb45c12fb9"
},
"downloads": -1,
"filename": "plasmapy-2024.10.0.tar.gz",
"has_sig": false,
"md5_digest": "c9c315a4b50cea2875f6d554d30f89aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 13443462,
"upload_time": "2024-10-30T00:34:35",
"upload_time_iso_8601": "2024-10-30T00:34:35.180311Z",
"url": "https://files.pythonhosted.org/packages/2d/2a/0ef20f8b8e75e537199608b68cd7e5750885195b09ddbc55d1a6075fa28f/plasmapy-2024.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-30 00:34:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PlasmaPy",
"github_project": "plasmapy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "plasmapy"
}
