# {py:mod}`airsspy.vasptools`

```{py:module} airsspy.vasptools
```

```{autodoc2-docstring} airsspy.vasptools
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`parse_potcar_map <airsspy.vasptools.parse_potcar_map>`
  - ```{autodoc2-docstring} airsspy.vasptools.parse_potcar_map
    :summary:
    ```
* - {py:obj}`parse_seed_incar <airsspy.vasptools.parse_seed_incar>`
  - ```{autodoc2-docstring} airsspy.vasptools.parse_seed_incar
    :summary:
    ```
* - {py:obj}`split_incar_settings <airsspy.vasptools.split_incar_settings>`
  - ```{autodoc2-docstring} airsspy.vasptools.split_incar_settings
    :summary:
    ```
* - {py:obj}`resolve_input_set_class <airsspy.vasptools.resolve_input_set_class>`
  - ```{autodoc2-docstring} airsspy.vasptools.resolve_input_set_class
    :summary:
    ```
* - {py:obj}`structure_from_cell_text <airsspy.vasptools.structure_from_cell_text>`
  - ```{autodoc2-docstring} airsspy.vasptools.structure_from_cell_text
    :summary:
    ```
* - {py:obj}`structure_from_res <airsspy.vasptools.structure_from_res>`
  - ```{autodoc2-docstring} airsspy.vasptools.structure_from_res
    :summary:
    ```
* - {py:obj}`assemble_potcar <airsspy.vasptools.assemble_potcar>`
  - ```{autodoc2-docstring} airsspy.vasptools.assemble_potcar
    :summary:
    ```
* - {py:obj}`prepare_vasp_inputs <airsspy.vasptools.prepare_vasp_inputs>`
  - ```{autodoc2-docstring} airsspy.vasptools.prepare_vasp_inputs
    :summary:
    ```
* - {py:obj}`build_vasp_rem_lines <airsspy.vasptools.build_vasp_rem_lines>`
  - ```{autodoc2-docstring} airsspy.vasptools.build_vasp_rem_lines
    :summary:
    ```
* - {py:obj}`compose_vasp_task_doc <airsspy.vasptools.compose_vasp_task_doc>`
  - ```{autodoc2-docstring} airsspy.vasptools.compose_vasp_task_doc
    :summary:
    ```
````

### Data

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

* - {py:obj}`CONTROL_INPUT_SET <airsspy.vasptools.CONTROL_INPUT_SET>`
  - ```{autodoc2-docstring} airsspy.vasptools.CONTROL_INPUT_SET
    :summary:
    ```
* - {py:obj}`CONTROL_PREFIX <airsspy.vasptools.CONTROL_PREFIX>`
  - ```{autodoc2-docstring} airsspy.vasptools.CONTROL_PREFIX
    :summary:
    ```
````

### API

````{py:data} CONTROL_INPUT_SET
:canonical: airsspy.vasptools.CONTROL_INPUT_SET
:value: >
   'AIRSSPY_VASP_INPUT_SET'

```{autodoc2-docstring} airsspy.vasptools.CONTROL_INPUT_SET
```

````

````{py:data} CONTROL_PREFIX
:canonical: airsspy.vasptools.CONTROL_PREFIX
:value: >
   'AIRSSPY_'

```{autodoc2-docstring} airsspy.vasptools.CONTROL_PREFIX
```

````

````{py:function} parse_potcar_map(values: tuple[str, ...] | list[str]) -> dict[str, str]
:canonical: airsspy.vasptools.parse_potcar_map

```{autodoc2-docstring} airsspy.vasptools.parse_potcar_map
```
````

````{py:function} parse_seed_incar(incar_content: str)
:canonical: airsspy.vasptools.parse_seed_incar

```{autodoc2-docstring} airsspy.vasptools.parse_seed_incar
```
````

````{py:function} split_incar_settings(incar) -> tuple[dict[str, typing.Any], dict[str, typing.Any]]
:canonical: airsspy.vasptools.split_incar_settings

```{autodoc2-docstring} airsspy.vasptools.split_incar_settings
```
````

````{py:function} resolve_input_set_class(name: str)
:canonical: airsspy.vasptools.resolve_input_set_class

```{autodoc2-docstring} airsspy.vasptools.resolve_input_set_class
```
````

````{py:function} structure_from_cell_text(cell_text: str)
:canonical: airsspy.vasptools.structure_from_cell_text

```{autodoc2-docstring} airsspy.vasptools.structure_from_cell_text
```
````

````{py:function} structure_from_res(path: str | pathlib.Path)
:canonical: airsspy.vasptools.structure_from_res

```{autodoc2-docstring} airsspy.vasptools.structure_from_res
```
````

````{py:function} assemble_potcar(structure, output_path: str | pathlib.Path, *, potcar_dir: str | None = None, potcar_map: dict[str, str] | None = None, resolved_symbols: dict[str, str] | None = None) -> list[dict[str, str]]
:canonical: airsspy.vasptools.assemble_potcar

```{autodoc2-docstring} airsspy.vasptools.assemble_potcar
```
````

````{py:function} prepare_vasp_inputs(struct_name: str, structure, incar_content: str, *, mode: str, pressure: float = 0.0, potcar_dir: str | None = None, potcar_map: dict[str, str] | None = None, kpoints_path: str | pathlib.Path | None = None, workdir: str | pathlib.Path | None = None) -> dict[str, typing.Any]
:canonical: airsspy.vasptools.prepare_vasp_inputs

```{autodoc2-docstring} airsspy.vasptools.prepare_vasp_inputs
```
````

````{py:function} build_vasp_rem_lines(struct_name: str, metadata: dict[str, typing.Any] | None = None) -> list[str]
:canonical: airsspy.vasptools.build_vasp_rem_lines

```{autodoc2-docstring} airsspy.vasptools.build_vasp_rem_lines
```
````

````{py:function} compose_vasp_task_doc(struct_name: str, metadata: dict[str, typing.Any] | None = None) -> dict[str, typing.Any]
:canonical: airsspy.vasptools.compose_vasp_task_doc

```{autodoc2-docstring} airsspy.vasptools.compose_vasp_task_doc
```
````