vice.core.dataframe.agb_yield_settings
======================================

The VICE dataframe: derived class (inherits from yield_settings)

Stores the current nucleosynthetic yield settings for asymptotic giant
branch (AGB) stars.

.. versionadded:: 1.2.0

.. note:: Modifying yield settings through these dataframes is equivalent
	to going through the vice.elements module.

Allowed Data Types
------------------
* Keys
	- ``str`` [case-insensitive] : elemental symbols
		The symbols of the elements as they appear on the periodic table.

* Values
	- ``str`` [case-insensitive] : keywords
		Denote a built-in table of net yields published in a
		nucleosynthesis study.

		Recognized Keywords:

			- "cristallo11" : Cristallo et al. (2011) [1]_
			- "karakas10" : Karakas (2010) [2]_
			- "ventura13" : Ventura et al. (2013) [3]_
			- "karakas16": Karakas & Lugaro (2016) [4]_; Karakas et al.
			  (2018) [5]_


	- <function> : Mathematical function describing the yield.
		Must accept the stellar mass in :math:`M_\odot` and the
		metallicity by mass :math:`Z` as parameters, in that order.

		.. note:: Functions of mass and metallicity to describe these
			yields can significantly increase the required integration
			time in simulations, especially for fine timestepping.

Indexing
--------
- ``str`` [case-insensitive] : elemental symbols
	Must be indexed by the symbol of an element recognized by VICE as it
	appears on the periodic table.

Functions
---------
- keys
- todict
- restore_defaults
- factory_settings
- save_defaults

Built-In Instances
------------------
- vice.yields.agb.settings
	The user's current nucleosynthetic yield settings for asymptotic giant
	branch stars.

Example Code
------------
>>> import math
>>> from vice.yields.agb import settings as example
>>> example["c"] = "karakas10"
>>> def f(m, z):
	return 1e-3 * m * math.exp(-m / 2) * (z / 0.014)
>>> example["C"] = f

**Signature**: vice.core.dataframe.agb_yield_settings(frame, name,
allow_funcs, config_field)

.. warning:: Users should avoid creating new instances of derived classes
	of the VICE dataframe and instead use the base class. Instances of
	this class are created automatically.

Parameters
----------
frame : ``dict``
	A dictionary from which to construct the dataframe.
name : ``str``
	String denoting a description of the values stored in this dataframe.
allow_funcs : ``bool``
	If True, functional attributes will be allowed.
config_field : ``str``
	The name of the ".config" file that is stored in VICE's install
	directory whenever the user saves new default yield settings.

.. [1] Cristallo et al. (2011), ApJS, 197, 17
.. [2] Karakas (2010), MNRAS, 403, 1413
.. [3] Ventura et al. (2013), MNRAS, 431, 3642
.. [4] Karakas & Lugaro (2016), ApJ, 825, 26
.. [5] Karakas et al. (2018), MNRAS, 477, 421