# {py:mod}`abtem.magnetism.utils`

```{py:module} abtem.magnetism.utils
```

```{autodoc2-docstring} abtem.magnetism.utils
:parser: rst
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`saturation_magnetization <abtem.magnetism.utils.saturation_magnetization>`
  - ```{autodoc2-docstring} abtem.magnetism.utils.saturation_magnetization
    :parser: rst
    :summary:
    ```
* - {py:obj}`set_magnetic_moments <abtem.magnetism.utils.set_magnetic_moments>`
  - ```{autodoc2-docstring} abtem.magnetism.utils.set_magnetic_moments
    :parser: rst
    :summary:
    ```
````

### Data

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

* - {py:obj}`bohr_magneton <abtem.magnetism.utils.bohr_magneton>`
  - ```{autodoc2-docstring} abtem.magnetism.utils.bohr_magneton
    :parser: rst
    :summary:
    ```
* - {py:obj}`vacuum_permeability <abtem.magnetism.utils.vacuum_permeability>`
  - ```{autodoc2-docstring} abtem.magnetism.utils.vacuum_permeability
    :parser: rst
    :summary:
    ```
````

### API

````{py:data} bohr_magneton
:canonical: abtem.magnetism.utils.bohr_magneton
:value: >
   None

```{autodoc2-docstring} abtem.magnetism.utils.bohr_magneton
:parser: rst
```

````

````{py:function} saturation_magnetization(...)
:canonical: abtem.magnetism.utils.saturation_magnetization

```{autodoc2-docstring} abtem.magnetism.utils.saturation_magnetization
:parser: rst
```
````

````{py:function} set_magnetic_moments(...)
:canonical: abtem.magnetism.utils.set_magnetic_moments

```{autodoc2-docstring} abtem.magnetism.utils.set_magnetic_moments
:parser: rst
```
````

````{py:data} vacuum_permeability
:canonical: abtem.magnetism.utils.vacuum_permeability
:value: >
   None

```{autodoc2-docstring} abtem.magnetism.utils.vacuum_permeability
:parser: rst
```

````