| Name | utilities-awetzel JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | None |
| Summary | utilities for Andrew Wetzel's packages |
| upload_time | 2024-07-12 17:29:07 |
| maintainer | None |
| docs_url | None |
| author | Shea Garrison-Kimmel, Jenna Samuel, Nico Garavito-Camargo, Kyle Oman |
| requires_python | >=3.9 |
| license | Copyright 2014-2024 by the authors. In summary, 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 AUTHORS 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 |
utilities
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 of utility functions that are useful in analyzing various datasets, in particular, catalogs of particles or galaxies/halos from cosmological simulations. (The GizmoAnalysis and HaloAnalysis packages depend on this package.)
---
# Requirements
python 3, numpy, scipy, h5py, matplotlib
---
# Content
## lower-level utilities
### array.py
* create, manipulate, analyze arrays
### binning.py
* binning of array data
### constant.py
* physical constants and unit conversions
### coordinate.py
* manipulate positions and velocities
### io.py
* read, write, print during run time
### math.py
* math, statistics, and fitting
### plot.py
* supplementary functions for plotting with matplotlib
## higher-level utilities
### catalog.py
* analyze catalogs of halos/galaxies
### cosmology.py
* calculate cosmological values, including cosmic density, distance, age, volume
### halo_property.py
* calculate halo properties at different radii, convert between virial definitions
### orbit.py
* compute orbital quantities such as peri/apo-centric distance, orbital time, in a given gravitational potential
### particle.py
* high-level analysis of N-body particle data
### simulation.py
* tools to help set up and run a simulation
---
# 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 is by using `pip`:
```
python -m pip install utilities_awetzel
```
Alternately, to install the latest stable version from source, clone from `bitbucket`:
```
git clone git://bitbucket.org/awetzel/utilities.git
```
then either point your PYTHONPATH to this repository or you build and install this project via pip by going inside the top-level `utilities` directory and:
```
python -m pip install .
```
---
# Using
Once installed, you can use individual modules like this:
```
import utilities as ut
ut.particle
```
Raw data
{
"_id": null,
"home_page": null,
"name": "utilities-awetzel",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Andrew Wetzel <arwetzel@gmail.com>",
"keywords": "utilities, astronomy, astrophysics, cosmology, galaxies, stars, dark matter",
"author": "Shea Garrison-Kimmel, Jenna Samuel, Nico Garavito-Camargo, Kyle Oman",
"author_email": "Andrew Wetzel <arwetzel@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/bd/f8/1b6a46334331e6121eae28fd255e83e28f4873635ee3e0e35ff00ae9a797/utilities_awetzel-1.0.2.tar.gz",
"platform": null,
"description": "# Description\n\nPython package of utility functions that are useful in analyzing various datasets, in particular, catalogs of particles or galaxies/halos from cosmological simulations. (The GizmoAnalysis and HaloAnalysis packages depend on this package.)\n\n\n---\n# Requirements\n\npython 3, numpy, scipy, h5py, matplotlib\n\n\n---\n# Content\n\n## lower-level utilities\n\n### array.py \n* create, manipulate, analyze arrays\n\n### binning.py\n* binning of array data\n\n### constant.py\n* physical constants and unit conversions\n\n### coordinate.py\n* manipulate positions and velocities\n\n### io.py\n* read, write, print during run time\n\n### math.py \n* math, statistics, and fitting\n\n### plot.py\n* supplementary functions for plotting with matplotlib\n\n\n## higher-level utilities\n\n### catalog.py\n* analyze catalogs of halos/galaxies\n\n### cosmology.py\n* calculate cosmological values, including cosmic density, distance, age, volume\n\n### halo_property.py\n* calculate halo properties at different radii, convert between virial definitions\n\n### orbit.py\n* compute orbital quantities such as peri/apo-centric distance, orbital time, in a given gravitational potential\n\n### particle.py\n* high-level analysis of N-body particle data\n\n### simulation.py\n* tools to help set up and run a simulation\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\n\nThe easiest way to install this packages is by using `pip`:\n\n```\npython -m pip install utilities_awetzel\n\n```\n\nAlternately, to install the latest stable version from source, clone from `bitbucket`:\n\n```\ngit clone git://bitbucket.org/awetzel/utilities.git\n```\n\nthen either point your PYTHONPATH to this repository or you build and install this project via pip by going inside the top-level `utilities` directory and:\n\n```\npython -m pip install .\n```\n\n\n---\n# Using\n\nOnce installed, you can use individual modules like this:\n\n```\nimport utilities as ut\nut.particle\n```\n",
"bugtrack_url": null,
"license": "Copyright 2014-2024 by the authors. In summary, 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 AUTHORS 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": "utilities for Andrew Wetzel's packages",
"version": "1.0.2",
"project_urls": {
"Issues": "https://bitbucket.org/awetzel/utilities/issues?status=new&status=open&status=submitted",
"Repository": "https://bitbucket.org/awetzel/utilities/src/master/"
},
"split_keywords": [
"utilities",
" astronomy",
" astrophysics",
" cosmology",
" galaxies",
" stars",
" dark matter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d18d87240a4a1cc0014bfa0d86de2feac3208dcaeda1a807ba0011f714e1e911",
"md5": "7a5bc5b5ef713f3d55ea78d88e5b77de",
"sha256": "aa2f7e15e29ce20fff1c9e3dfafb0f313f0f62e475a3a123ebe0b776dbf58475"
},
"downloads": -1,
"filename": "utilities_awetzel-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7a5bc5b5ef713f3d55ea78d88e5b77de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 111477,
"upload_time": "2024-07-12T17:29:06",
"upload_time_iso_8601": "2024-07-12T17:29:06.086221Z",
"url": "https://files.pythonhosted.org/packages/d1/8d/87240a4a1cc0014bfa0d86de2feac3208dcaeda1a807ba0011f714e1e911/utilities_awetzel-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bdf81b6a46334331e6121eae28fd255e83e28f4873635ee3e0e35ff00ae9a797",
"md5": "c7e596ef942bdae27bec32776fbebac7",
"sha256": "4ece12e488495a69be55f4c9ef0bc02e0f176dc7d90beb223f9adda53906a387"
},
"downloads": -1,
"filename": "utilities_awetzel-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "c7e596ef942bdae27bec32776fbebac7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 106969,
"upload_time": "2024-07-12T17:29:07",
"upload_time_iso_8601": "2024-07-12T17:29:07.600672Z",
"url": "https://files.pythonhosted.org/packages/bd/f8/1b6a46334331e6121eae28fd255e83e28f4873635ee3e0e35ff00ae9a797/utilities_awetzel-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-12 17:29:07",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "awetzel",
"bitbucket_project": "utilities",
"lcname": "utilities-awetzel"
}
