Package Contents¶
VICE: Versatile Integrator for Chemical Evolution
Provides¶
A dataframe object meant for case-insensitive lookup
Simulations of galactic chemical evolution models
Simulations of nucleosynthesis from single stellar populations
Built-in yield tables from nucleosynthesis studies
How to Access the Documentation:¶
Documentation is available in several forms:
Online: http://vice-astro.readthedocs.io
In PDF format, available for download at the same address
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
.
Example scripts can be found under examples/ in the git repository at http://github.com/giganano/VICE.
Contents¶
- singlezone
type
Simulate a single-zone galactic chemical evolution model
- output
type
Read and store output from single- and multi-zone 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.
- 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
type
An extension to the Python type
dict
to allow case-insensitivity.- history<function>
Reads in time-evolution of interstellar medium from singlezone simulation.
- mdf<function>
Reads in stellar metallicity distribution from singlezone simulation.
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.
- vice.version
- vice.atomic_number
- vice.primordial
- vice.solar_z
- vice.sources
- vice.stable_isotopes
- vice.cumulative_return_fraction
- vice.main_sequence_mass_fraction
- vice.single_stellar_population
- vice.dataframe
- vice.dataframe.keys
- vice.dataframe.todict
- vice.dataframe.remove
- vice.dataframe.filter
- vice.core.dataframe.builtin_elemental_data
- vice.core.dataframe.elemental_settings
- vice.core.dataframe.evolutionary_settings
- vice.core.dataframe.fromfile
- vice.core.dataframe.noncustomizable
- vice.core.dataframe.history
- vice.core.dataframe.saved_yields
- vice.yields
- vice.yields.agb
- vice.yields.ccsne
- vice.yields.sneia
- vice.yields.presets
- vice.elements
- vice.imf
- vice.singlezone
- vice.singlezone.run
- vice.singlezone.from_output
- vice.singlezone.name
- vice.singlezone.func
- vice.singlezone.mode
- vice.singlezone.verbose
- vice.singlezone.elements
- vice.singlezone.IMF
- vice.singlezone.eta
- vice.singlezone.enhancement
- vice.singlezone.Zin
- vice.singlezone.recycling
- vice.singlezone.bins
- vice.singlezone.delay
- vice.singlezone.RIa
- vice.singlezone.Mg0
- vice.singlezone.smoothing
- vice.singlezone.tau_ia
- vice.singlezone.tau_star
- vice.singlezone.dt
- vice.singlezone.schmidt
- vice.singlezone.schmidt_index
- vice.singlezone.MgSchmidt
- vice.singlezone.m_upper
- vice.singlezone.m_lower
- vice.singlezone.postMS
- vice.singlezone.Z_solar
- vice.singlezone.agb_model
- vice.history
- vice.mdf
- vice.output
- vice.mirror
- vice.ScienceWarning
- vice.VisibleRuntimeWarning
- vice.VisibleDeprecationWarning