Package Contents¶
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:
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
. 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.
- 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.mlr
- vice.yields
- vice.yields.agb
- vice.yields.ccsne
- vice.yields.ccsne.fractional
- vice.yields.ccsne.table
- vice.yields.ccsne.settings
- vice.yields.ccsne.engines
- vice.yields.ccsne.WW95
- vice.yields.ccsne.CL04
- vice.yields.ccsne.CL13
- vice.yields.ccsne.NKT13
- vice.yields.ccsne.S16
- vice.yields.ccsne.LC18
- 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.entrainment
- 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.multizone
- vice.milkyway
- vice.milkyway.annuli
- vice.milkyway.zone_width
- vice.milkyway.evolution
- vice.milkyway.default_evolution
- vice.milkyway.mode
- vice.milkyway.elements
- vice.milkyway.IMF
- vice.milkyway.mass_loading
- vice.milkyway.default_mass_loading
- vice.milkyway.dt
- vice.milkyway.bins
- vice.milkyway.delay
- vice.milkyway.RIa
- vice.milkyway.smoothing
- vice.milkyway.tau_ia
- vice.milkyway.m_upper
- vice.milkyway.m_lower
- vice.milkyway.postMS
- vice.milkyway.Z_solar
- vice.migration
- vice.history
- vice.mdf
- vice.output
- vice.multioutput
- vice.stars
- vice.mirror
- vice.toolkit
- vice.dataframe
- vice.dataframe.keys
- vice.dataframe.todict
- vice.dataframe.remove
- vice.dataframe.filter
- vice.core.dataframe.agb_yield_settings
- vice.core.dataframe.ccsn_yield_table
- vice.core.dataframe.channel_entrainment
- vice.core.dataframe.elemental_settings
- vice.core.dataframe.evolutionary_settings
- vice.core.dataframe.fromfile
- vice.core.dataframe.history
- vice.core.dataframe.noncustomizable
- vice.core.dataframe.saved_yields
- vice.core.dataframe.tracers
- vice.core.dataframe.yield_settings
- vice.ScienceWarning
- vice.VisibleRuntimeWarning
- vice.VisibleDeprecationWarning