# {py:mod}`physpyx.nuclide`

```{py:module} physpyx.nuclide
```

```{autodoc2-docstring} physpyx.nuclide
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`DecayData <physpyx.nuclide.DecayData>`
  -
* - {py:obj}`PossibleDecays <physpyx.nuclide.PossibleDecays>`
  -
* - {py:obj}`Channel <physpyx.nuclide.Channel>`
  - ```{autodoc2-docstring} physpyx.nuclide.Channel
    :summary:
    ```
* - {py:obj}`DecayChannels <physpyx.nuclide.DecayChannels>`
  - ```{autodoc2-docstring} physpyx.nuclide.DecayChannels
    :summary:
    ```
* - {py:obj}`Radioactivity <physpyx.nuclide.Radioactivity>`
  - ```{autodoc2-docstring} physpyx.nuclide.Radioactivity
    :summary:
    ```
* - {py:obj}`Nuclide <physpyx.nuclide.Nuclide>`
  - ```{autodoc2-docstring} physpyx.nuclide.Nuclide
    :summary:
    ```
* - {py:obj}`NuclideTable <physpyx.nuclide.NuclideTable>`
  - ```{autodoc2-docstring} physpyx.nuclide.NuclideTable
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`logger <physpyx.nuclide.logger>`
  - ```{autodoc2-docstring} physpyx.nuclide.logger
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: physpyx.nuclide.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} physpyx.nuclide.logger
```

````

`````{py:class} DecayData()
:canonical: physpyx.nuclide.DecayData

Bases: {py:obj}`typing.TypedDict`

````{py:attribute} color
:canonical: physpyx.nuclide.DecayData.color
:type: str
:value: >
   None

```{autodoc2-docstring} physpyx.nuclide.DecayData.color
```

````

````{py:attribute} label
:canonical: physpyx.nuclide.DecayData.label
:type: str
:value: >
   None

```{autodoc2-docstring} physpyx.nuclide.DecayData.label
```

````

````{py:attribute} ratio
:canonical: physpyx.nuclide.DecayData.ratio
:type: float
:value: >
   None

```{autodoc2-docstring} physpyx.nuclide.DecayData.ratio
```

````

`````

`````{py:class} PossibleDecays(color: str, label: str, channels: dict[str, str])
:canonical: physpyx.nuclide.PossibleDecays

Bases: {py:obj}`enum.Enum`

````{py:attribute} ALPHA
:canonical: physpyx.nuclide.PossibleDecays.ALPHA
:value: >
   ('#3f80ae', '$\\alpha$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.ALPHA
```

````

````{py:attribute} FISSION
:canonical: physpyx.nuclide.PossibleDecays.FISSION
:value: >
   ('#52b552', 'SF')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.FISSION
```

````

````{py:attribute} TWO_PROTON
:canonical: physpyx.nuclide.PossibleDecays.TWO_PROTON
:value: >
   ('#52b552', '$2p$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.TWO_PROTON
```

````

````{py:attribute} PROTON
:canonical: physpyx.nuclide.PossibleDecays.PROTON
:value: >
   ('#7d7ad6', '$p$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.PROTON
```

````

````{py:attribute} BETA_PLUS
:canonical: physpyx.nuclide.PossibleDecays.BETA_PLUS
:value: >
   ('#d67d7a', '$\\beta^+$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.BETA_PLUS
```

````

````{py:attribute} TWO_BETA_PLUS
:canonical: physpyx.nuclide.PossibleDecays.TWO_BETA_PLUS
:value: >
   ('#ca5753', '$2\\beta^+$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.TWO_BETA_PLUS
```

````

````{py:attribute} STABLE
:canonical: physpyx.nuclide.PossibleDecays.STABLE
:value: >
   ('#c7522a', '')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.STABLE
```

````

````{py:attribute} TWO_BETA_MINUS
:canonical: physpyx.nuclide.PossibleDecays.TWO_BETA_MINUS
:value: >
   ('#e5c185', '$2\\beta^-$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.TWO_BETA_MINUS
```

````

````{py:attribute} BETA_MINUS
:canonical: physpyx.nuclide.PossibleDecays.BETA_MINUS
:value: >
   ('#fbf2c4', '$\\beta^-$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.BETA_MINUS
```

````

````{py:attribute} NEUTRON
:canonical: physpyx.nuclide.PossibleDecays.NEUTRON
:value: >
   ('#74a892', '$n$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.NEUTRON
```

````

````{py:attribute} TWO_NEUTRON
:canonical: physpyx.nuclide.PossibleDecays.TWO_NEUTRON
:value: >
   ('#52b552', '$2n$')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.TWO_NEUTRON
```

````

````{py:attribute} UNKOWN
:canonical: physpyx.nuclide.PossibleDecays.UNKOWN
:value: >
   ('#a0a0a0', '')

```{autodoc2-docstring} physpyx.nuclide.PossibleDecays.UNKOWN
```

````

`````

`````{py:class} Channel(channel: str, prob: float)
:canonical: physpyx.nuclide.Channel

```{autodoc2-docstring} physpyx.nuclide.Channel
```

```{rubric} Initialization
```

```{autodoc2-docstring} physpyx.nuclide.Channel.__init__
```

````{py:property} label
:canonical: physpyx.nuclide.Channel.label
:type: str

```{autodoc2-docstring} physpyx.nuclide.Channel.label
```

````

````{py:property} color
:canonical: physpyx.nuclide.Channel.color
:type: str

```{autodoc2-docstring} physpyx.nuclide.Channel.color
```

````

````{py:method} __str__() -> str
:canonical: physpyx.nuclide.Channel.__str__

````

`````

`````{py:class} DecayChannels(data: list[str])
:canonical: physpyx.nuclide.DecayChannels

```{autodoc2-docstring} physpyx.nuclide.DecayChannels
```

```{rubric} Initialization
```

```{autodoc2-docstring} physpyx.nuclide.DecayChannels.__init__
```

````{py:method} __str__() -> str
:canonical: physpyx.nuclide.DecayChannels.__str__

````

````{py:method} __getitem__(c: int) -> physpyx.nuclide.Channel
:canonical: physpyx.nuclide.DecayChannels.__getitem__

```{autodoc2-docstring} physpyx.nuclide.DecayChannels.__getitem__
```

````

`````

`````{py:class} Radioactivity(data: list[str])
:canonical: physpyx.nuclide.Radioactivity

```{autodoc2-docstring} physpyx.nuclide.Radioactivity
```

```{rubric} Initialization
```

```{autodoc2-docstring} physpyx.nuclide.Radioactivity.__init__
```

````{py:method} __str__() -> str
:canonical: physpyx.nuclide.Radioactivity.__str__

````

````{py:method} __getitem__(c: int) -> physpyx.nuclide.Channel
:canonical: physpyx.nuclide.Radioactivity.__getitem__

```{autodoc2-docstring} physpyx.nuclide.Radioactivity.__getitem__
```

````

````{py:method} to_tex(N: int, Z: int) -> typing.Generator[str]
:canonical: physpyx.nuclide.Radioactivity.to_tex

```{autodoc2-docstring} physpyx.nuclide.Radioactivity.to_tex
```

````

`````

`````{py:class} Nuclide(data: list[str])
:canonical: physpyx.nuclide.Nuclide

```{autodoc2-docstring} physpyx.nuclide.Nuclide
```

```{rubric} Initialization
```

```{autodoc2-docstring} physpyx.nuclide.Nuclide.__init__
```

````{py:property} stable
:canonical: physpyx.nuclide.Nuclide.stable
:type: bool

```{autodoc2-docstring} physpyx.nuclide.Nuclide.stable
```

````

````{py:method} __str__() -> str
:canonical: physpyx.nuclide.Nuclide.__str__

````

````{py:method} __repr__() -> str
:canonical: physpyx.nuclide.Nuclide.__repr__

````

````{py:method} __eq__(other: object) -> bool
:canonical: physpyx.nuclide.Nuclide.__eq__

````

````{py:method} to_tex(*, with_symbol: bool = True, with_mass: bool = False, with_decay: bool = False) -> typing.Generator[str]
:canonical: physpyx.nuclide.Nuclide.to_tex

```{autodoc2-docstring} physpyx.nuclide.Nuclide.to_tex
```

````

`````

`````{py:class} NuclideTable()
:canonical: physpyx.nuclide.NuclideTable

```{autodoc2-docstring} physpyx.nuclide.NuclideTable
```

```{rubric} Initialization
```

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.__init__
```

````{py:method} __iter__() -> typing.Iterator[physpyx.nuclide.Nuclide]
:canonical: physpyx.nuclide.NuclideTable.__iter__

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.__iter__
```

````

````{py:method} get(*, N: int | None = None, Z: int | None = None, A: int | None = None, symbol: str | None = None) -> physpyx.nuclide.Nuclide
:canonical: physpyx.nuclide.NuclideTable.get

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.get
```

````

````{py:method} range(*, N: typing.Iterable[int] | None = None, Z: typing.Iterable[int] | None = None, A: typing.Iterable[int] | None = None) -> list[physpyx.nuclide.Nuclide]
:canonical: physpyx.nuclide.NuclideTable.range

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.range
```

````

````{py:method} legend(nuclides: list[physpyx.nuclide.Nuclide], x: float, y: float, vertical: bool) -> typing.Generator[str]
:canonical: physpyx.nuclide.NuclideTable.legend
:classmethod:

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.legend
```

````

````{py:method} define_colors() -> typing.Generator[str]
:canonical: physpyx.nuclide.NuclideTable.define_colors
:classmethod:

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.define_colors
```

````

````{py:method} axis(nuclides: list[physpyx.nuclide.Nuclide]) -> typing.Generator[str]
:canonical: physpyx.nuclide.NuclideTable.axis
:classmethod:

```{autodoc2-docstring} physpyx.nuclide.NuclideTable.axis
```

````

`````