Python AutoDoc#

SAW: Standard Atomic Weights.

ICE: Isotopic Compositions of the element.

NAW: Nuclide’s Atomic Weights.

get_ice(s: str, A: int, uncertainty: bool = False) float#

Get the isotopic composition of the element s for the mass number A.

DEPRECATED: It will be removed in the next major release. Use ice() instead.

Parameters:
s: str

Element symbol.

A: int

Mass number.

uncertainty: bool, optional

Flag to get the uncertainty instead of the value. Default to False.

Returns:
ice: float

Returns NaN if the provided element or the mass number A are incorrect or -1 if the element does not have an ICE.

get_naw(s: str, A: int, uncertainty: bool = False) float#

Get the atomic weight of the nuclide s for the mass number A.

DEPRECATED: It will be removed in the next major release. Use naw() instead.

Parameters:
s: str

Element symbol.

A: int

Mass number.

uncertainty: bool, optional

Flag to get the uncertainty instead of the value. Default to False.

Returns:
naw: float

Returns NaN if the provided element or A are incorrect or -1 if the element does not have an NAW.

get_nice(s: str) int#

Get the number of isotopes in ICE of the element s.

DEPRECATED: It will be removed in the next major release. Use nice() instead.

Parameters:
s: str

Element symbol.

Returns:
nice: int

Returns -1 if the provided element is incorrect.

get_nnaw(s: str) int#

Get the number of nuclides in NAW of the element s.

DEPRECATED: It will be removed in the next major release. Use nnaw() instead.

Parameters:
s: str

Element symbol.

Returns:
nnaw: int

Returns -1 if the provided element is incorrect.

get_saw(s: str, abridged: bool = True, uncertainty: bool = False) float#

Get the standard atomic weight of the element s.

DEPRECATED: It will be removed in the next major release. Use saw() instead.

Parameters:
s: str

Element symbol.

abridged: bool, optional

Flag for the abridged value. Default to True.

uncertainty: bool, optional

Flag to get the uncertainty instead of the value. Default to False.

ice(s: str, A: int, u: bool = False) float#

Get the isotopic composition of the element s for the mass number A.

Parameters:
s: str

Element symbol.

A: int

Mass number.

u: bool, optional

Flag to get the uncertainty instead of the value. Default to False.

Returns:
ice: float

Returns NaN if the provided element or the mass number A are incorrect or -1 if the element does not have an ICE.

naw(s: str, A: int, u: bool = False) float#

Get the atomic weight of the nuclide s for the mass number A.

DEPRECATED: It will be removed in the next major release. Use naw() instead.

Parameters:
s: str

Element symbol.

A: int

Mass number.

u: bool, optional

Flag to get the uncertainty instead of the value. Default to False.

Returns:
naw: float

Returns NaN if the provided element or A are incorrect or -1 if the element does not have an NAW.

nice(s: str) int#

Get the number of isotopes in ICE of the element s.

Parameters:
s: str

Element symbol.

Returns:
nice: int

Returns -1 if the provided element is incorrect.

nnaw(s: str) int#

Get the number of nuclides in NAW of the element s.

Parameters:
s: str

Element symbol.

Returns:
nnaw: int

Returns -1 if the provided element is incorrect.

saw(s: str, ab: bool = True, u: bool = False) float#

Get the standard atomic weight of the element s.

Parameters:
s: str

Element symbol.

ab: bool, optional

Flag for the abridged value. Default to True.

u: bool, optional

Flag to get the uncertainty instead of the value. Default to False.