# {py:mod}`snf_simulations.scripts.command_line`

```{py:module} snf_simulations.scripts.command_line
```

```{autodoc2-docstring} snf_simulations.scripts.command_line
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`main <snf_simulations.scripts.command_line.main>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.main
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`run <snf_simulations.scripts.command_line.run>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.run
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`run_compare <snf_simulations.scripts.command_line.run_compare>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.run_compare
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`run_multiple <snf_simulations.scripts.command_line.run_multiple>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.run_multiple
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`run_multiple_full <snf_simulations.scripts.command_line.run_multiple_full>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.run_multiple_full
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`run_sample <snf_simulations.scripts.command_line.run_sample>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.run_sample
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`run_single <snf_simulations.scripts.command_line.run_single>`
  - ```{autodoc2-docstring} snf_simulations.scripts.command_line.run_single
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:function} main() -> None
:canonical: snf_simulations.scripts.command_line.main

```{autodoc2-docstring} snf_simulations.scripts.command_line.main
:parser: autodoc2_docstrings_parser
```
````

````{py:function} run(reactor: str = 'sizewell', cask_mass: float = 10000) -> None
:canonical: snf_simulations.scripts.command_line.run

```{autodoc2-docstring} snf_simulations.scripts.command_line.run
:parser: autodoc2_docstrings_parser
```
````

````{py:function} run_compare(spec_05: snf_simulations.spec.Spectrum, spec_multiple: snf_simulations.spec.Spectrum, reactor: str = 'sizewell') -> None
:canonical: snf_simulations.scripts.command_line.run_compare

```{autodoc2-docstring} snf_simulations.scripts.command_line.run_compare
:parser: autodoc2_docstrings_parser
```
````

````{py:function} run_multiple(reactor: str = 'sizewell', cask_mass: float = 10000, casks_per_removal: int = 10) -> snf_simulations.spec.Spectrum
:canonical: snf_simulations.scripts.command_line.run_multiple

```{autodoc2-docstring} snf_simulations.scripts.command_line.run_multiple
:parser: autodoc2_docstrings_parser
```
````

````{py:function} run_multiple_full(reactor: str = 'sizewell', cask_mass: float = 10000, casks_per_removal: int = 10) -> None
:canonical: snf_simulations.scripts.command_line.run_multiple_full

```{autodoc2-docstring} snf_simulations.scripts.command_line.run_multiple_full
:parser: autodoc2_docstrings_parser
```
````

````{py:function} run_sample(spec: snf_simulations.spec.Spectrum, reactor: str = 'sizewell') -> None
:canonical: snf_simulations.scripts.command_line.run_sample

```{autodoc2-docstring} snf_simulations.scripts.command_line.run_sample
:parser: autodoc2_docstrings_parser
```
````

````{py:function} run_single(reactor: str = 'sizewell', cask_mass: float = 10000) -> snf_simulations.spec.Spectrum
:canonical: snf_simulations.scripts.command_line.run_single

```{autodoc2-docstring} snf_simulations.scripts.command_line.run_single
:parser: autodoc2_docstrings_parser
```
````