# {py:mod}`nexusLIMS.utils.paths`

```{py:module} nexusLIMS.utils.paths
```

```{autodoc2-docstring} nexusLIMS.utils.paths
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`is_subpath <nexusLIMS.utils.paths.is_subpath>`
  - ```{autodoc2-docstring} nexusLIMS.utils.paths.is_subpath
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`join_instrument_filestore_path <nexusLIMS.utils.paths.join_instrument_filestore_path>`
  - ```{autodoc2-docstring} nexusLIMS.utils.paths.join_instrument_filestore_path
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`replace_instrument_data_path <nexusLIMS.utils.paths.replace_instrument_data_path>`
  - ```{autodoc2-docstring} nexusLIMS.utils.paths.replace_instrument_data_path
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:function} is_subpath(path: pathlib.Path, of_paths: typing.Union[pathlib.Path, typing.List[pathlib.Path]])
:canonical: nexusLIMS.utils.paths.is_subpath

```{autodoc2-docstring} nexusLIMS.utils.paths.is_subpath
:parser: autodoc2_docstrings_parser
```
````

````{py:function} join_instrument_filestore_path(filestore_path: str) -> pathlib.Path
:canonical: nexusLIMS.utils.paths.join_instrument_filestore_path

```{autodoc2-docstring} nexusLIMS.utils.paths.join_instrument_filestore_path
:parser: autodoc2_docstrings_parser
```
````

````{py:function} replace_instrument_data_path(path: pathlib.Path, suffix: str) -> pathlib.Path
:canonical: nexusLIMS.utils.paths.replace_instrument_data_path

```{autodoc2-docstring} nexusLIMS.utils.paths.replace_instrument_data_path
:parser: autodoc2_docstrings_parser
```
````