VICE: Versatile Integrator for Chemical Evolution
* 77 elements on the periodic table
* Fast integration of one-zone models
* Enrichment from single stellar populations
* Highly flexible nucleosynthetic yield calculations
* User-defined mathematical forms describing:
- Nucleosynthetic yields in simulations
- Mixing processes in multi-zone models
- Infall and star formation histories
- The stellar initial mass function
- The star formation law
- Element-by-element infall metallicities
- Type Ia supernova delay-time distributions
How to Access the Documentation:
--------------------------------
Documentation is available in several forms:
1. Online: http://vice-astro.readthedocs.io
2. In PDF format, available for download at the same address
3. In the docstrings embedded within the software
Running ``vice --docs`` from the terminal will open the online documentation
in the default web browser.
First time users should go through VICE's QuickStartTutorial jupyter notebook,
available under examples/ in the git repository. This can be launched from
the command line by running ``vice --tutorial``. Other example scripts can
be found there as well.
Contents
--------
singlezone : ``object``
Simulate a single-zone galactic chemical evolution model
multizone : ``object``
Simulate a multi-zone galactic chemical evolution model
milkyway : ``object``
A ``multizone`` object optimized for modeling the Milky Way.
output : ``object``
Read and store output from ``singlezone`` simulations.
multioutput : ``object``
Read and store output from ``multizone`` simulations.
migration : <module>
Utilities for mixing prescriptions in multizone simulations.
single_stellar_population : <function>
Simulate enrichment from a single conatal star cluster
cumulative_return_fraction : <function>
Calculate the cumulative return fraction of a star cluster of known age
main_sequence_mass_fraction : <function>
Calculate the main sequence mass fraction of a star cluster of known age
imf : <module>
Built-in funcitonal forms of popular stellar initial mass functions.
mlr : ``object``
Built-in popular function forms of the stellar mass-lifetime relationship.
Also stores which form to adopt in chemical evolution models.
yields : <module>
Calculate, access, and declare nucleosynthetic yield settings for use in
simulations.
elements : <module>
Access, and declare nucleosynthetic yield settings for use in simulations.
Access other relevant information for each element such as the solar
abundance or atomic number.
dataframe : ``object``
A dictionary-like object with case-insensitive lookup and data storage.
history : <function>
Reads in time-evolution of interstellar medium from singlezone simulation.
mdf : <function>
Reads in stellar metallicity distribution from singlezone simulation.
stars : <function>
Read in stellar population abundances from a multizone simulation output.
toolkit : <module>
Generally useful utilities.
Built-In Dataframes
-------------------
- atomic_number : The atomic number of each element
- primordial : The abundance of each element following big bang nucleosynthesis.
- solar_z : The abundance of each element in the sun.
- sources : The primary astrophysical production channels of each element.
- stable_isotopes : Lists of each elements' stable isotopes.
Utilities
---------
- VisibleDeprecationWarning : A DeprecationWarning that is visible by default.
- VisibleRuntimeWarning : A RuntimeWarning that is visible by default.
- ScienceWarning : A Warning concerning scientific accuracy and precision.
- test : Runs VICE's unit tests.
- version : VICE's version breakdown.
- __version__ : The version string.
Raw data
{
"_id": null,
"home_page": "https://github.com/giganano/VICE.git",
"name": "vice",
"maintainer": "James W. Johnson",
"docs_url": null,
"requires_python": ">=3.8,<4",
"maintainer_email": "giganano9@gmail.com",
"keywords": "galaxies,simulations,abundances",
"author": "James W. Johnson",
"author_email": "giganano9@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f4/1b/7f1ae74f38082acbee1a25ce6b83b025b835c369396c8b326bc7dffaebe1/vice-1.3.1.tar.gz",
"platform": "Linux",
"description": "\nVICE: Versatile Integrator for Chemical Evolution\n\n* 77 elements on the periodic table\n* Fast integration of one-zone models\n* Enrichment from single stellar populations\n* Highly flexible nucleosynthetic yield calculations\n* User-defined mathematical forms describing:\n\t- Nucleosynthetic yields in simulations\n\t- Mixing processes in multi-zone models\n\t- Infall and star formation histories\n\t- The stellar initial mass function\n\t- The star formation law\n\t- Element-by-element infall metallicities\n\t- Type Ia supernova delay-time distributions\n\nHow to Access the Documentation:\n--------------------------------\nDocumentation is available in several forms:\n\n\t1. Online: http://vice-astro.readthedocs.io\n\t2. In PDF format, available for download at the same address\n\t3. In the docstrings embedded within the software\n\nRunning ``vice --docs`` from the terminal will open the online documentation\nin the default web browser.\n\nFirst time users should go through VICE's QuickStartTutorial jupyter notebook,\navailable under examples/ in the git repository. This can be launched from\nthe command line by running ``vice --tutorial``. Other example scripts can\nbe found there as well.\n\nContents\n--------\nsinglezone : ``object``\n\tSimulate a single-zone galactic chemical evolution model\nmultizone : ``object``\n\tSimulate a multi-zone galactic chemical evolution model\nmilkyway : ``object``\n\tA ``multizone`` object optimized for modeling the Milky Way.\noutput : ``object``\n\tRead and store output from ``singlezone`` simulations.\nmultioutput : ``object``\n\tRead and store output from ``multizone`` simulations.\nmigration : <module>\n\tUtilities for mixing prescriptions in multizone simulations.\nsingle_stellar_population : <function>\n\tSimulate enrichment from a single conatal star cluster\ncumulative_return_fraction : <function>\n\tCalculate the cumulative return fraction of a star cluster of known age\nmain_sequence_mass_fraction : <function>\n\tCalculate the main sequence mass fraction of a star cluster of known age\nimf : <module>\n\tBuilt-in funcitonal forms of popular stellar initial mass functions.\nmlr : ``object``\n\tBuilt-in popular function forms of the stellar mass-lifetime relationship.\n\tAlso stores which form to adopt in chemical evolution models.\nyields : <module>\n\tCalculate, access, and declare nucleosynthetic yield settings for use in\n\tsimulations.\nelements : <module>\n\tAccess, and declare nucleosynthetic yield settings for use in simulations.\n\tAccess other relevant information for each element such as the solar\n\tabundance or atomic number.\ndataframe : ``object``\n\tA dictionary-like object with case-insensitive lookup and data storage.\nhistory : <function>\n\tReads in time-evolution of interstellar medium from singlezone simulation.\nmdf : <function>\n\tReads in stellar metallicity distribution from singlezone simulation.\nstars : <function>\n\tRead in stellar population abundances from a multizone simulation output.\ntoolkit : <module>\n\tGenerally useful utilities.\n\nBuilt-In Dataframes\n-------------------\n- atomic_number : The atomic number of each element\n- primordial : The abundance of each element following big bang nucleosynthesis.\n- solar_z : The abundance of each element in the sun.\n- sources : The primary astrophysical production channels of each element.\n- stable_isotopes : Lists of each elements' stable isotopes.\n\nUtilities\n---------\n- VisibleDeprecationWarning : A DeprecationWarning that is visible by default.\n- VisibleRuntimeWarning : A RuntimeWarning that is visible by default.\n- ScienceWarning : A Warning concerning scientific accuracy and precision.\n- test : Runs VICE's unit tests.\n- version : VICE's version breakdown.\n- __version__ : The version string.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Galactic Chemical Evolution Integrator",
"version": "1.3.1",
"project_urls": {
"Bug Tracker": "https://github.com/giganano/VICE/issues",
"Documentation": "https://vice-astro.readthedocs.io/",
"Homepage": "https://github.com/giganano/VICE.git",
"Source Code": "https://github.com/giganano/VICE.git"
},
"split_keywords": [
"galaxies",
"simulations",
"abundances"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f41b7f1ae74f38082acbee1a25ce6b83b025b835c369396c8b326bc7dffaebe1",
"md5": "4d36ad13d6ea8343a3fda8cc051c6768",
"sha256": "194fc726bbc09687fb51ae23cc1fbab8b251b9d8f990c40714127721618e98f7"
},
"downloads": -1,
"filename": "vice-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "4d36ad13d6ea8343a3fda8cc051c6768",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4",
"size": 1891663,
"upload_time": "2023-10-25T22:40:32",
"upload_time_iso_8601": "2023-10-25T22:40:32.435918Z",
"url": "https://files.pythonhosted.org/packages/f4/1b/7f1ae74f38082acbee1a25ce6b83b025b835c369396c8b326bc7dffaebe1/vice-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 22:40:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "giganano",
"github_project": "VICE",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "vice"
}
JSON
