| Name | osyris JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | None |
| Summary | A package to visualize AMR data from the RAMSES code |
| upload_time | 2024-11-11 09:12:59 |
| maintainer | None |
| docs_url | None |
| author | Neil Vaytet |
| requires_python | >=3.7 |
| license | BSD 3-Clause License Copyright (c) 2024, Osyris contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. Neither the name of the copyright holder 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://osyris.readthedocs.io/en/stable/?badge=latest)
[](https://app.gitter.im/#/room/#osyris-project_community:gitter.im)
# Osyris
A python visualization utility for RAMSES astrophysical simulations data.
Osyris aims to remain portable, lightweight and fast,
to allow users to quickly explore and understand their simulation data,
as well as produce publication grade figures.
## Documentation
The documentation for `osyris` can be found at https://osyris.readthedocs.io.
## Installation
```sh
pip install osyris
```
## A short example
You can download the sample data
[here](https://github.com/osyris-project/osyrisdata/archive/refs/heads/main.zip).
Plot a 2D histogram of the cell magnetic field versus the gas density.
```python
import numpy as np
import osyris
data = osyris.RamsesDataset(8, path="data").load()
osyris.hist2d(data["mesh"]["density"], data["mesh"]["B_field"],
norm="log", loglog=True)
```
Create a 2D gas density map 2000 au wide through the plane normal to ``z``,
with velocity vectors overlayed as arrows, once again using ``layers``:
```python
ind = np.argmax(data["mesh"]["density"])
center = data["mesh"]["position"][ind]
osyris.map(
data["mesh"].layer("density", norm="log"),
data["mesh"].layer("velocity", mode="vec"),
dx=2000 * osyris.units("au"),
origin=center,
direction="z",
)
```
## Have a problem or need a new feature?
- Bug reports or feature requests should be submitted by opening an [issue](https://github.com/osyris-project/osyris/issues)
- For general discussions or questions about how to do something with `osyris`, start a new [discussion](https://github.com/osyris-project/osyris/discussions)
## Logo credit
[Icon vector created by frimufilms - www.freepik.com](https://www.freepik.com/free-photos-vectors/icon)
Raw data
{
"_id": null,
"home_page": null,
"name": "osyris",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Neil Vaytet",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/f1/73/2406846bf4922bf770fdbe8949ca62494b8adcaf77b6152c7368285ade03/osyris-3.0.0.tar.gz",
"platform": null,
"description": "[](https://osyris.readthedocs.io/en/stable/?badge=latest)\n[](https://app.gitter.im/#/room/#osyris-project_community:gitter.im)\n\n# Osyris\n\nA python visualization utility for RAMSES astrophysical simulations data.\nOsyris aims to remain portable, lightweight and fast,\nto allow users to quickly explore and understand their simulation data,\nas well as produce publication grade figures.\n\n## Documentation\n\nThe documentation for `osyris` can be found at https://osyris.readthedocs.io.\n\n## Installation\n\n```sh\npip install osyris\n```\n\n## A short example\n\nYou can download the sample data\n[here](https://github.com/osyris-project/osyrisdata/archive/refs/heads/main.zip).\n\nPlot a 2D histogram of the cell magnetic field versus the gas density.\n\n```python\nimport numpy as np\nimport osyris\n\ndata = osyris.RamsesDataset(8, path=\"data\").load()\nosyris.hist2d(data[\"mesh\"][\"density\"], data[\"mesh\"][\"B_field\"],\n norm=\"log\", loglog=True)\n```\n\n\nCreate a 2D gas density map 2000 au wide through the plane normal to ``z``,\nwith velocity vectors overlayed as arrows, once again using ``layers``:\n\n```python\nind = np.argmax(data[\"mesh\"][\"density\"])\ncenter = data[\"mesh\"][\"position\"][ind]\nosyris.map(\n data[\"mesh\"].layer(\"density\", norm=\"log\"),\n data[\"mesh\"].layer(\"velocity\", mode=\"vec\"),\n dx=2000 * osyris.units(\"au\"),\n origin=center,\n direction=\"z\",\n)\n```\n\n\n## Have a problem or need a new feature?\n\n- Bug reports or feature requests should be submitted by opening an [issue](https://github.com/osyris-project/osyris/issues)\n- For general discussions or questions about how to do something with `osyris`, start a new [discussion](https://github.com/osyris-project/osyris/discussions)\n\n## Logo credit\n\n[Icon vector created by frimufilms - www.freepik.com](https://www.freepik.com/free-photos-vectors/icon)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2024, Osyris contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. 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. 3. Neither the name of the copyright holder 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": "A package to visualize AMR data from the RAMSES code",
"version": "3.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/osyris-project/osyris/issues",
"Documentation": "https://osyris.readthedocs.io",
"Source": "https://github.com/osyris-project/osyris"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71a1ef2955605ce9168179ee9e371ea984a1b1606be5c86d64528447542d6c35",
"md5": "01313a0015d419d6457e0de5250fda07",
"sha256": "69f04e79ecaccc14b0dab471b92327c765767bdfc783e3569564dc796d7133ce"
},
"downloads": -1,
"filename": "osyris-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01313a0015d419d6457e0de5250fda07",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 53458,
"upload_time": "2024-11-11T09:12:57",
"upload_time_iso_8601": "2024-11-11T09:12:57.674634Z",
"url": "https://files.pythonhosted.org/packages/71/a1/ef2955605ce9168179ee9e371ea984a1b1606be5c86d64528447542d6c35/osyris-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f1732406846bf4922bf770fdbe8949ca62494b8adcaf77b6152c7368285ade03",
"md5": "f9593d96af30bbcdbd051b5e148b9185",
"sha256": "d61353f29f18ceaf14775de74b2477a7b03387c0e55409ad9dab207148d3497a"
},
"downloads": -1,
"filename": "osyris-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f9593d96af30bbcdbd051b5e148b9185",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 183082,
"upload_time": "2024-11-11T09:12:59",
"upload_time_iso_8601": "2024-11-11T09:12:59.436607Z",
"url": "https://files.pythonhosted.org/packages/f1/73/2406846bf4922bf770fdbe8949ca62494b8adcaf77b6152c7368285ade03/osyris-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-11 09:12:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osyris-project",
"github_project": "osyris",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "osyris"
}
