Metadata-Version: 2.1
Name: vice
Version: 1.1.0
Summary: Galactic Chemical Evolution Integrator
Home-page: http://github.com/giganano/VICE.git
Author: James W. Johnson
Author-email: giganano9@gmail.com
Maintainer: James W. Johnson
Maintainer-email: giganano9@gmail.com
License: MIT
Keywords: galaxies,simulations,abundances
Platform: Linux
Platform: Mac OS X
Platform: Unix
Classifier: Development Status :: 5 - Production/Stable 
Classifier: Intended Audience :: Science/Research 
Classifier: License :: OSI Approved :: MIT License 
Classifier: Natural Language :: English 
Classifier: Operating System :: MacOS 
Classifier: Operating System :: POSIX 
Classifier: Operating System :: Unix 
Classifier: Programming Language :: C 
Classifier: Programming Language :: Cython 
Classifier: Programming Language :: Python 
Classifier: Programming Language :: Python :: 3  
Classifier: Programming Language :: Python :: 3.5 
Classifier: Programming Language :: Python :: 3.6 
Classifier: Programming Language :: Python :: 3.7 
Classifier: Programming Language :: Python :: 3.8 
Classifier: Programming Language :: Python :: 3 :: Only 
Classifier: Programming Language :: Python :: Implementation :: CPython 
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy 
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: 
Provides: vice
Requires-Python: >=3.5.*, <4


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: 

	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``. 

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. 


