# {py:mod}`airsspy.fullrelax`

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

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

## Module Contents

### Classes

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

* - {py:obj}`FullRelax <airsspy.fullrelax.FullRelax>`
  - ```{autodoc2-docstring} airsspy.fullrelax.FullRelax
    :summary:
    ```
````

### Functions

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

* - {py:obj}`check_relax_status <airsspy.fullrelax.check_relax_status>`
  - ```{autodoc2-docstring} airsspy.fullrelax.check_relax_status
    :summary:
    ```
* - {py:obj}`parse_geom_text_output <airsspy.fullrelax.parse_geom_text_output>`
  - ```{autodoc2-docstring} airsspy.fullrelax.parse_geom_text_output
    :summary:
    ```
* - {py:obj}`geom_to_cell <airsspy.fullrelax.geom_to_cell>`
  - ```{autodoc2-docstring} airsspy.fullrelax.geom_to_cell
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <airsspy.fullrelax.logger>`
  - ```{autodoc2-docstring} airsspy.fullrelax.logger
    :summary:
    ```
````

### API

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

```{autodoc2-docstring} airsspy.fullrelax.logger
```

````

`````{py:class} FullRelax(exe: str, struct_name: str, maxit: int, initial_cycle: int = 4, initial_length: int = 4, alter_cell_cons: bool = False)
:canonical: airsspy.fullrelax.FullRelax

```{autodoc2-docstring} airsspy.fullrelax.FullRelax
```

```{rubric} Initialization
```

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.__init__
```

````{py:property} dot_castep
:canonical: airsspy.fullrelax.FullRelax.dot_castep
:type: str

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.dot_castep
```

````

````{py:property} dot_param
:canonical: airsspy.fullrelax.FullRelax.dot_param
:type: str

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.dot_param
```

````

````{py:property} dot_cell
:canonical: airsspy.fullrelax.FullRelax.dot_cell
:type: str

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.dot_cell
```

````

````{py:property} dot_cell_out
:canonical: airsspy.fullrelax.FullRelax.dot_cell_out
:type: str

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.dot_cell_out
```

````

````{py:method} check_param() -> None
:canonical: airsspy.fullrelax.FullRelax.check_param

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.check_param
```

````

````{py:method} save_state() -> None
:canonical: airsspy.fullrelax.FullRelax.save_state

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.save_state
```

````

````{py:method} load_state() -> None
:canonical: airsspy.fullrelax.FullRelax.load_state

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.load_state
```

````

````{py:method} fixed_cell_off() -> None
:canonical: airsspy.fullrelax.FullRelax.fixed_cell_off

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.fixed_cell_off
```

````

````{py:method} fixed_cell_on() -> None
:canonical: airsspy.fullrelax.FullRelax.fixed_cell_on

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.fixed_cell_on
```

````

````{py:method} run(timeout: typing.Optional[float] = None) -> str
:canonical: airsspy.fullrelax.FullRelax.run

```{autodoc2-docstring} airsspy.fullrelax.FullRelax.run
```

````

````{py:method} __repr__() -> str
:canonical: airsspy.fullrelax.FullRelax.__repr__

````

`````

````{py:function} check_relax_status(dot_castep: str) -> tuple[bool, int]
:canonical: airsspy.fullrelax.check_relax_status

```{autodoc2-docstring} airsspy.fullrelax.check_relax_status
```
````

````{py:function} parse_geom_text_output(out_lines: list[str]) -> dict[str, numpy.ndarray]
:canonical: airsspy.fullrelax.parse_geom_text_output

```{autodoc2-docstring} airsspy.fullrelax.parse_geom_text_output
```
````

````{py:function} geom_to_cell(geom_file: str) -> tuple[str, str]
:canonical: airsspy.fullrelax.geom_to_cell

```{autodoc2-docstring} airsspy.fullrelax.geom_to_cell
```
````