| Name | gizmo-analysis JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | read and analyze Gizmo simulations |
| upload_time | 2024-07-12 17:30:05 |
| maintainer | None |
| docs_url | None |
| author | Shea Garrison-Kimmel, Andrew Emerick, Zach Hafen, Isaiah Santistevan, Nico Garavito-Camargo, Kyle Oman |
| requires_python | >=3.9 |
| license | Copyright 2014-2024 by the authors. If you use this package, please cite it, along the lines of: 'This work used GizmoAnalysis (http://ascl.net/2002.015), which first was used in Wetzel et al 2016 (https://ui.adsabs.harvard.edu/abs/2016ApJ...827L..23W).' You are free to use, edit, share, and do whatever you want. But please cite it and report bugs. Less succinctly, this software is governed by the MIT License: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE aAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
gizmo
astronomy
astrophysics
cosmology
galaxies
stars
dark matter
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Description
Python package for reading and analyzing simulations generated using the Gizmo code, in particular, the FIRE cosmological simulations.
---
# Requirements
python 3, numpy, scipy, h5py, matplotlib
This package also requires the [utilities/](https://bitbucket.org/awetzel/utilities) Python package for various utility functions.
---
# Contents
## gizmo_analysis
### gizmo_io.py
* read particles from Gizmo snapshot files
### gizmo_plot.py
* analyze and plot particle data
### gizmo_track.py
* track star particles and gas cells across snapshots
### gizmo_file.py
* clean, compress, delete, or transfer Gizmo snapshot files
### gizmo_diagnostic.py
* run diagnostics on Gizmo simulations
### gizmo_ic.py
* generate cosmological zoom-in initial conditions from existing snapshot files
### gizmo_star.py
* models of stellar evolution as implemented in FIRE-2 and FIRE-3: rates and yields from supernovae (core-collapse and white-dwarf) and stellar winds
### gizmo_elementtracer.py
* generate elemental abundances in star particles and gas cells in post-processing, using the element-tracer module
## tutorials
### gizmo_tutorial_read.ipynb
* Jupyter notebook tutorial for reading particle data, understanding its data structure and units
### gizmo_tutorial_analysis.ipynb
* Jupyter notebook tutorial for analyzing and plotting particle data
### transcript.txt
* Transcript of Zach Hafen's video tutorial (https://www.youtube.com/watch?v=bl-rpzE8hrU) on using this package to read FIRE simulations.
## data
### snapshot_times.txt
* example file for storing information about snapshots: scale-factors, redshifts, times, etc
---
# Units
Unless otherwise noted, this package stores all quantities in (combinations of) these base units
* mass [M_sun]
* position [kpc comoving]
* distance, radius [kpc physical]
* time [Gyr]
* temperature [K]
* magnetic field [Gauss]
* elemental abundance [linear mass fraction]
These are the common exceptions to those standards
* velocity [km/s]
* acceleration [km/s / Gyr]
* gravitational potential [km^2 / s^2]
* rates (star formation, cooling, accretion) [M_sun / yr]
* metallicity (if converted from stored massfraction) [log10(mass_fraction / mass_fraction_solar)], using Asplund et al 2009 for Solar
---
# Installing
The easiest way to install this packages and all of its dependencies is by using `pip`:
```
python -m pip install gizmo_analysis
```
Alternately, to install the latest stable version from source, clone from `bitbucket`:
```
git clone git://bitbucket.org/awetzel/gizmo_analysis.git
```
then either point your PYTHONPATH to this repository (along with our utilities repository that it depends on), or build and install this project via pip by going inside the top-level `gizmo_analysis` directory and:
```
python -m pip install .
```
---
# Using
Once installed, you can call individual modules like this:
```
import gizmo_analysis as gizmo
gizmo.io
```
---
# Citing
If you use this package, please cite it, along the lines of: 'This work used GizmoAnalysis (http://ascl.net/2002.015), which first was used in Wetzel et al 2016 (https://ui.adsabs.harvard.edu/abs/2016ApJ...827L..23W).'
Raw data
{
"_id": null,
"home_page": null,
"name": "gizmo-analysis",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Andrew Wetzel <arwetzel@gmail.com>",
"keywords": "gizmo, astronomy, astrophysics, cosmology, galaxies, stars, dark matter",
"author": "Shea Garrison-Kimmel, Andrew Emerick, Zach Hafen, Isaiah Santistevan, Nico Garavito-Camargo, Kyle Oman",
"author_email": "Andrew Wetzel <arwetzel@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/35/ca/654a5a065337fbc34e00e5556de302ed8387d368a8799b10b812056eab3a/gizmo_analysis-1.0.2.tar.gz",
"platform": null,
"description": "# Description\n\nPython package for reading and analyzing simulations generated using the Gizmo code, in particular, the FIRE cosmological simulations.\n\n\n---\n# Requirements\n\npython 3, numpy, scipy, h5py, matplotlib\n\nThis package also requires the [utilities/](https://bitbucket.org/awetzel/utilities) Python package for various utility functions.\n\n\n---\n# Contents\n\n## gizmo_analysis\n\n### gizmo_io.py\n* read particles from Gizmo snapshot files\n\n### gizmo_plot.py\n* analyze and plot particle data\n\n### gizmo_track.py\n* track star particles and gas cells across snapshots\n### gizmo_file.py\n* clean, compress, delete, or transfer Gizmo snapshot files\n\n### gizmo_diagnostic.py\n* run diagnostics on Gizmo simulations\n\n### gizmo_ic.py\n* generate cosmological zoom-in initial conditions from existing snapshot files\n\n### gizmo_star.py\n* models of stellar evolution as implemented in FIRE-2 and FIRE-3: rates and yields from supernovae (core-collapse and white-dwarf) and stellar winds\n\n### gizmo_elementtracer.py\n* generate elemental abundances in star particles and gas cells in post-processing, using the element-tracer module\n\n\n## tutorials\n\n### gizmo_tutorial_read.ipynb\n* Jupyter notebook tutorial for reading particle data, understanding its data structure and units\n\n### gizmo_tutorial_analysis.ipynb\n* Jupyter notebook tutorial for analyzing and plotting particle data\n\n### transcript.txt\n* Transcript of Zach Hafen's video tutorial (https://www.youtube.com/watch?v=bl-rpzE8hrU) on using this package to read FIRE simulations.\n\n\n## data\n\n### snapshot_times.txt\n* example file for storing information about snapshots: scale-factors, redshifts, times, etc\n\n\n---\n# Units\n\nUnless otherwise noted, this package stores all quantities in (combinations of) these base units\n* mass [M_sun]\n* position [kpc comoving]\n* distance, radius [kpc physical]\n* time [Gyr]\n* temperature [K]\n* magnetic field [Gauss]\n* elemental abundance [linear mass fraction]\n\nThese are the common exceptions to those standards\n* velocity [km/s]\n* acceleration [km/s / Gyr]\n* gravitational potential [km^2 / s^2]\n* rates (star formation, cooling, accretion) [M_sun / yr]\n* metallicity (if converted from stored massfraction) [log10(mass_fraction / mass_fraction_solar)], using Asplund et al 2009 for Solar\n\n\n---\n# Installing\n\nThe easiest way to install this packages and all of its dependencies is by using `pip`:\n\n```\npython -m pip install gizmo_analysis\n\n```\n\nAlternately, to install the latest stable version from source, clone from `bitbucket`:\n\n```\ngit clone git://bitbucket.org/awetzel/gizmo_analysis.git\n```\n\nthen either point your PYTHONPATH to this repository (along with our utilities repository that it depends on), or build and install this project via pip by going inside the top-level `gizmo_analysis` directory and:\n\n```\npython -m pip install .\n```\n\n\n---\n# Using\n\nOnce installed, you can call individual modules like this:\n\n```\nimport gizmo_analysis as gizmo\ngizmo.io\n```\n\n\n---\n# Citing\n\nIf you use this package, please cite it, along the lines of: 'This work used GizmoAnalysis (http://ascl.net/2002.015), which first was used in Wetzel et al 2016 (https://ui.adsabs.harvard.edu/abs/2016ApJ...827L..23W).'\n",
"bugtrack_url": null,
"license": "Copyright 2014-2024 by the authors. If you use this package, please cite it, along the lines of: 'This work used GizmoAnalysis (http://ascl.net/2002.015), which first was used in Wetzel et al 2016 (https://ui.adsabs.harvard.edu/abs/2016ApJ...827L..23W).' You are free to use, edit, share, and do whatever you want. But please cite it and report bugs. Less succinctly, this software is governed by the MIT License: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE aAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "read and analyze Gizmo simulations",
"version": "1.0.2",
"project_urls": {
"Issues": "https://bitbucket.org/awetzel/gizmo_analysis/issues?status=new&status=open&status=submitted",
"Repository": "https://bitbucket.org/awetzel/gizmo_analysis/src/master/"
},
"split_keywords": [
"gizmo",
" astronomy",
" astrophysics",
" cosmology",
" galaxies",
" stars",
" dark matter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "105f4ad3cf5bfea63345f65fe624a901045d5e3143c6dd40776fe0a087259219",
"md5": "41799dcc5dfe1a649d6b14112daa523c",
"sha256": "d6bd837b95a0f063c52d32b199ebd8ffa1b68c08b2a4be2d34a93f75f47f7053"
},
"downloads": -1,
"filename": "gizmo_analysis-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41799dcc5dfe1a649d6b14112daa523c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 161475,
"upload_time": "2024-07-12T17:30:02",
"upload_time_iso_8601": "2024-07-12T17:30:02.913214Z",
"url": "https://files.pythonhosted.org/packages/10/5f/4ad3cf5bfea63345f65fe624a901045d5e3143c6dd40776fe0a087259219/gizmo_analysis-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "35ca654a5a065337fbc34e00e5556de302ed8387d368a8799b10b812056eab3a",
"md5": "fcc25ba37f6b0b74a3ce5b7567d1a63d",
"sha256": "c31b09e22ce6f4be15601f93fbffb8b49ed55a33c7052c4199ec0db919ca4b45"
},
"downloads": -1,
"filename": "gizmo_analysis-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "fcc25ba37f6b0b74a3ce5b7567d1a63d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 156141,
"upload_time": "2024-07-12T17:30:05",
"upload_time_iso_8601": "2024-07-12T17:30:05.279535Z",
"url": "https://files.pythonhosted.org/packages/35/ca/654a5a065337fbc34e00e5556de302ed8387d368a8799b10b812056eab3a/gizmo_analysis-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-12 17:30:05",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "awetzel",
"bitbucket_project": "gizmo_analysis",
"lcname": "gizmo-analysis"
}
