# {py:mod}`airsspy.cli.cmd_run`

```{py:module} airsspy.cli.cmd_run
```

```{autodoc2-docstring} airsspy.cli.cmd_run
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`run <airsspy.cli.cmd_run.run>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.run
    :summary:
    ```
* - {py:obj}`run_search <airsspy.cli.cmd_run.run_search>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.run_search
    :summary:
    ```
* - {py:obj}`run_crud <airsspy.cli.cmd_run.run_crud>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.run_crud
    :summary:
    ```
* - {py:obj}`run_relax <airsspy.cli.cmd_run.run_relax>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.run_relax
    :summary:
    ```
* - {py:obj}`run_sp <airsspy.cli.cmd_run.run_sp>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.run_sp
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <airsspy.cli.cmd_run.logger>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.logger
    :summary:
    ```
* - {py:obj}`STOP_FILE_NAME <airsspy.cli.cmd_run.STOP_FILE_NAME>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.STOP_FILE_NAME
    :summary:
    ```
* - {py:obj}`EXE_DEFAULTS <airsspy.cli.cmd_run.EXE_DEFAULTS>`
  - ```{autodoc2-docstring} airsspy.cli.cmd_run.EXE_DEFAULTS
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: airsspy.cli.cmd_run.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} airsspy.cli.cmd_run.logger
```

````

````{py:data} STOP_FILE_NAME
:canonical: airsspy.cli.cmd_run.STOP_FILE_NAME
:value: >
   'stop'

```{autodoc2-docstring} airsspy.cli.cmd_run.STOP_FILE_NAME
```

````

````{py:data} EXE_DEFAULTS
:canonical: airsspy.cli.cmd_run.EXE_DEFAULTS
:value: >
   None

```{autodoc2-docstring} airsspy.cli.cmd_run.EXE_DEFAULTS
```

````

````{py:function} run()
:canonical: airsspy.cli.cmd_run.run

```{autodoc2-docstring} airsspy.cli.cmd_run.run
```
````

````{py:function} run_search(seed, nmax, code, exe, workdir, keep, pack, build_only, pressure, max_iterations, build_timeout, cluster, mpinp, walltime_buffer, formulas, formula_elements, formula_max_coeff, formula_target_volumes, formula_oxidation_states, no_formula_charge_neutral, formula_diagnose, prune, prune_pool_size, prune_keep_fraction, prune_dedup_tol, prune_fingerprint_cutoff, prune_stable_window, prune_mean_abs_tol, prune_median_abs_tol, prune_zweight, prune_keep_rejected, potcar_dir, potcar_map_values)
:canonical: airsspy.cli.cmd_run.run_search

```{autodoc2-docstring} airsspy.cli.cmd_run.run_search
```
````

````{py:function} run_crud(code, exe, workdir, num, nostop, cycle, keep, singlepoint, pressure, max_iterations, cluster, mpinp, walltime_buffer, calculator_spec, optimizer, fmax, device, batch_size, potcar_dir, potcar_map_values)
:canonical: airsspy.cli.cmd_run.run_crud

```{autodoc2-docstring} airsspy.cli.cmd_run.run_crud
```
````

````{py:function} run_relax(cell, seed, code, exe, workdir, keep, pack, singlepoint, pressure, max_iterations, cluster, mpinp, walltime_buffer, calculator_spec, optimizer, fmax, device, batch_size, debug, potcar_dir, potcar_map_values)
:canonical: airsspy.cli.cmd_run.run_relax

```{autodoc2-docstring} airsspy.cli.cmd_run.run_relax
```
````

````{py:function} run_sp(cell, seed, code, exe, workdir, keep, pack, walltime_buffer, calculator_spec, device, batch_size, pressure, potcar_dir, potcar_map_values)
:canonical: airsspy.cli.cmd_run.run_sp

```{autodoc2-docstring} airsspy.cli.cmd_run.run_sp
```
````