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

An object describing an element on the periodic table and its astrophysical
nucleosynthetic sources and their associated yields.

**Signature**: vice.elements.element(symbol)

.. versionadded:: 1.1.0

Parameters
----------
symbol : ``str`` [case-insensitive]
	The symbol of the element as it appears on the periodic table.

Attributes
----------
symbol : ``str``
	The symbol of the element as it appears on the periodic table.
name : ``str``
	The full name of the element in English.
yields : ``yields``
	The ``yields`` object containing the nucleosynthetic yield settings
	for this element.
atomic_number : ``int``
	The atomic number (protons only) of this element.
primordial : ``float``
	The primordial abundance by mass of this element according to the
	standard model [3]_ [4]_ [5]_.
solar_z : ``float``
	The abundance by mass of this element in the sun as determined by
	Asplund et al. (2009) [1]_.
sources : ``list`` of strings
	The dominant astrophysical sources of this element as reported by
	Johnson (2019) [2]_.
stable_isotopes : ``list`` of integers
	The mass numbers (protons and neutrons) of the stable isotopes of
	this element.

.. seealso::
	- vice.yields.agb.settings
	- vice.yields.ccsne.settings
	- vice.yields.sneia.settings
	- vice.atomic_number
	- vice.primordial
	- vice.solar_z
	- vice.sources
	- vice.stable_isotopes

Example Code
------------
>>> 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
	}

.. [1] Asplund et al. (2009), ARA&A, 47, 481
.. [2] Johnson (2019), Science, 363, 474
.. [3] Planck Collaboration et al. (2016), A&A, 594, A13
.. [4] Pitrou et al. (2018), Phys. Rep., 754, 1
.. [5] Pattie et al. (2018), Science, 360, 627




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

	vice.elements.element.symbol
	vice.elements.element.name
	vice.elements.element.yields
	vice.elements.element.atomic_number
	vice.elements.element.primordial
	vice.elements.element.solar_z
	vice.elements.element.sources
	vice.elements.element.stable_isotopes