vice.elements
=============

Chemical Elements

Provides a means of accessing nucleosynthetic yield information on an
element-by-element basis.

.. versionadded:: 1.1.0

Contents
--------
recognized : ``tuple`` of strings
	The symbols of all elements that VICE recognizes as they appear on the
	periodic table.
element : ``type``
	Provides a means of accessing and modifying relevant information for
	different elements as well nucleosynthetic yields.
yields : ``type``
	Provides a means of accessing and modifying nucleosynthetic yield settings.

Element objects can be created from their symbols, or accessed directly
through VICE's namespace. For example:

>>> import vice
>>> vice.elements.Fe
	vice.element{
		symbol ------------ > Fe
		name -------------- > Iron
		atomic number ----- > 26
		primordial -------- > 0
		solar abundance --- > 0.00129
		sources ----------- > ['CCSNE', 'SNEIA']
		stable isotopes --- > [54, 56, 57, 58]
		yields.ccsne ------ > 0.000246
		yields.sneia ------ > 0.00258
		yields.agb -------- > cristallo11
	}
>>> example = vice.elements.element("sr")
>>> example
	vice.element{
		symbol ------------ > Sr
		name -------------- > Strontium
		atomic number ----- > 38
		primordial -------- > 0
		solar abundance --- > 4.74e-08
		sources ----------- > ['CCSNE', 'AGB']
		stable isotopes --- > [84, 86, 87, 88]
		yields.ccsne ------ > 1.34e-08
		yields.sneia ------ > 0
		yields.agb -------- > cristallo11
	}
>>> example.symbol = 'fe'
>>> example
	vice.element{
		symbol ------------ > Fe
		name -------------- > Iron
		atomic number ----- > 26
		primordial -------- > 0
		solar abundance --- > 0.00129
		sources ----------- > ['CCSNE', 'SNEIA']
		stable isotopes --- > [54, 56, 57, 58]
		yields.ccsne ------ > 0.000246
		yields.sneia ------ > 0.00258
		yields.agb -------- > cristallo11
	}

.. seealso::
	- vice.yields
	- vice.atomic_number
	- vice.primordial
	- vice.solar_z
	- vice.sources
	- vice.stable_isotopes




.. toctree::
	:titlesonly:
	:maxdepth: 5

	vice.elements.recognized
	vice.elements.element
	vice.elements.yields