# {py:mod}`nexusLIMS.instruments`

```{py:module} nexusLIMS.instruments
```

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

## Module Contents

### Functions

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

* - {py:obj}`get_instr_from_filepath <nexusLIMS.instruments.get_instr_from_filepath>`
  - ```{autodoc2-docstring} nexusLIMS.instruments.get_instr_from_filepath
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_instr_from_calendar_name <nexusLIMS.instruments.get_instr_from_calendar_name>`
  - ```{autodoc2-docstring} nexusLIMS.instruments.get_instr_from_calendar_name
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_instr_from_api_url <nexusLIMS.instruments.get_instr_from_api_url>`
  - ```{autodoc2-docstring} nexusLIMS.instruments.get_instr_from_api_url
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

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

* - {py:obj}`instrument_db <nexusLIMS.instruments.instrument_db>`
  - ```{autodoc2-docstring} nexusLIMS.instruments.instrument_db
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:data} instrument_db
:canonical: nexusLIMS.instruments.instrument_db

**Type:** dict

```{autodoc2-docstring} nexusLIMS.instruments.instrument_db
:parser: autodoc2_docstrings_parser
```

````

````{py:function} get_instr_from_filepath(path: pathlib.Path) -> nexusLIMS.db.models.Instrument | None
:canonical: nexusLIMS.instruments.get_instr_from_filepath

```{autodoc2-docstring} nexusLIMS.instruments.get_instr_from_filepath
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_instr_from_calendar_name(cal_name)
:canonical: nexusLIMS.instruments.get_instr_from_calendar_name

```{autodoc2-docstring} nexusLIMS.instruments.get_instr_from_calendar_name
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_instr_from_api_url(api_url: str) -> nexusLIMS.db.models.Instrument | None
:canonical: nexusLIMS.instruments.get_instr_from_api_url

```{autodoc2-docstring} nexusLIMS.instruments.get_instr_from_api_url
:parser: autodoc2_docstrings_parser
```
````