# {py:mod}`airsspy.scheduler`

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

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

## Module Contents

### Classes

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

* - {py:obj}`Scheduler <airsspy.scheduler.Scheduler>`
  - ```{autodoc2-docstring} airsspy.scheduler.Scheduler
    :summary:
    ```
* - {py:obj}`Dummy <airsspy.scheduler.Dummy>`
  - ```{autodoc2-docstring} airsspy.scheduler.Dummy
    :summary:
    ```
* - {py:obj}`SGE <airsspy.scheduler.SGE>`
  - ```{autodoc2-docstring} airsspy.scheduler.SGE
    :summary:
    ```
* - {py:obj}`Slurm <airsspy.scheduler.Slurm>`
  - ```{autodoc2-docstring} airsspy.scheduler.Slurm
    :summary:
    ```
````

### Data

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

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

### API

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

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

````

`````{py:class} Scheduler()
:canonical: airsspy.scheduler.Scheduler

```{autodoc2-docstring} airsspy.scheduler.Scheduler
```

```{rubric} Initialization
```

```{autodoc2-docstring} airsspy.scheduler.Scheduler.__init__
```

````{py:method} get_n_cpus() -> typing.Optional[int]
:canonical: airsspy.scheduler.Scheduler.get_n_cpus
:abstractmethod:

```{autodoc2-docstring} airsspy.scheduler.Scheduler.get_n_cpus
```

````

````{py:property} user_name
:canonical: airsspy.scheduler.Scheduler.user_name
:type: str

```{autodoc2-docstring} airsspy.scheduler.Scheduler.user_name
```

````

````{py:method} get_remaining_seconds() -> int
:canonical: airsspy.scheduler.Scheduler.get_remaining_seconds
:abstractmethod:

```{autodoc2-docstring} airsspy.scheduler.Scheduler.get_remaining_seconds
```

````

````{py:property} is_in_job
:canonical: airsspy.scheduler.Scheduler.is_in_job
:type: bool

```{autodoc2-docstring} airsspy.scheduler.Scheduler.is_in_job
```

````

````{py:property} job_id
:canonical: airsspy.scheduler.Scheduler.job_id
:abstractmethod:
:type: typing.Optional[str]

```{autodoc2-docstring} airsspy.scheduler.Scheduler.job_id
```

````

````{py:method} get_scheduler() -> typing.Optional[airsspy.scheduler.Scheduler]
:canonical: airsspy.scheduler.Scheduler.get_scheduler
:classmethod:

```{autodoc2-docstring} airsspy.scheduler.Scheduler.get_scheduler
```

````

`````

`````{py:class} Dummy()
:canonical: airsspy.scheduler.Dummy

Bases: {py:obj}`airsspy.scheduler.Scheduler`

```{autodoc2-docstring} airsspy.scheduler.Dummy
```

```{rubric} Initialization
```

```{autodoc2-docstring} airsspy.scheduler.Dummy.__init__
```

````{py:attribute} DEFAULT_REMAINING_TIME
:canonical: airsspy.scheduler.Dummy.DEFAULT_REMAINING_TIME
:value: >
   None

```{autodoc2-docstring} airsspy.scheduler.Dummy.DEFAULT_REMAINING_TIME
```

````

````{py:method} get_n_cpus() -> int
:canonical: airsspy.scheduler.Dummy.get_n_cpus

````

````{py:property} job_id
:canonical: airsspy.scheduler.Dummy.job_id
:type: str

````

````{py:method} get_remaining_seconds() -> int
:canonical: airsspy.scheduler.Dummy.get_remaining_seconds

```{autodoc2-docstring} airsspy.scheduler.Dummy.get_remaining_seconds
```

````

````{py:property} is_in_job
:canonical: airsspy.scheduler.Dummy.is_in_job
:type: bool

````

`````

`````{py:class} SGE()
:canonical: airsspy.scheduler.SGE

Bases: {py:obj}`airsspy.scheduler.Scheduler`

```{autodoc2-docstring} airsspy.scheduler.SGE
```

```{rubric} Initialization
```

```{autodoc2-docstring} airsspy.scheduler.SGE.__init__
```

````{py:property} job_id
:canonical: airsspy.scheduler.SGE.job_id
:type: typing.Optional[str]

````

````{py:property} is_in_job
:canonical: airsspy.scheduler.SGE.is_in_job
:type: bool

````

````{py:method} get_n_cpus() -> typing.Optional[int]
:canonical: airsspy.scheduler.SGE.get_n_cpus

```{autodoc2-docstring} airsspy.scheduler.SGE.get_n_cpus
```

````

````{py:method} get_max_run_seconds() -> typing.Optional[int]
:canonical: airsspy.scheduler.SGE.get_max_run_seconds

```{autodoc2-docstring} airsspy.scheduler.SGE.get_max_run_seconds
```

````

````{py:method} get_end_time() -> typing.Optional[datetime.datetime]
:canonical: airsspy.scheduler.SGE.get_end_time

```{autodoc2-docstring} airsspy.scheduler.SGE.get_end_time
```

````

````{py:method} get_start_time() -> typing.Optional[datetime.datetime]
:canonical: airsspy.scheduler.SGE.get_start_time

```{autodoc2-docstring} airsspy.scheduler.SGE.get_start_time
```

````

````{py:method} get_remaining_seconds() -> int
:canonical: airsspy.scheduler.SGE.get_remaining_seconds

```{autodoc2-docstring} airsspy.scheduler.SGE.get_remaining_seconds
```

````

`````

`````{py:class} Slurm()
:canonical: airsspy.scheduler.Slurm

Bases: {py:obj}`airsspy.scheduler.Scheduler`

```{autodoc2-docstring} airsspy.scheduler.Slurm
```

```{rubric} Initialization
```

```{autodoc2-docstring} airsspy.scheduler.Slurm.__init__
```

````{py:property} is_in_job
:canonical: airsspy.scheduler.Slurm.is_in_job
:type: bool

```{autodoc2-docstring} airsspy.scheduler.Slurm.is_in_job
```

````

````{py:property} job_id
:canonical: airsspy.scheduler.Slurm.job_id
:type: typing.Optional[str]

````

````{py:method} get_end_time() -> typing.Optional[datetime.datetime]
:canonical: airsspy.scheduler.Slurm.get_end_time

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_end_time
```

````

````{py:method} get_remaining_seconds() -> int
:canonical: airsspy.scheduler.Slurm.get_remaining_seconds

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_remaining_seconds
```

````

````{py:method} get_user_name() -> typing.Optional[str]
:canonical: airsspy.scheduler.Slurm.get_user_name

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_user_name
```

````

````{py:method} get_n_cpus() -> typing.Optional[str]
:canonical: airsspy.scheduler.Slurm.get_n_cpus

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_n_cpus
```

````

````{py:method} get_array_id() -> typing.Optional[str]
:canonical: airsspy.scheduler.Slurm.get_array_id

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_array_id
```

````

````{py:method} get_array_task_id() -> typing.Optional[str]
:canonical: airsspy.scheduler.Slurm.get_array_task_id

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_array_task_id
```

````

````{py:method} get_array_job_id() -> typing.Optional[str]
:canonical: airsspy.scheduler.Slurm.get_array_job_id

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_array_job_id
```

````

````{py:method} hold_array(array_num: typing.Optional[str] = None) -> None
:canonical: airsspy.scheduler.Slurm.hold_array

```{autodoc2-docstring} airsspy.scheduler.Slurm.hold_array
```

````

````{py:method} hold_all_pd_arrays(user_name: typing.Optional[str] = None) -> None
:canonical: airsspy.scheduler.Slurm.hold_all_pd_arrays

```{autodoc2-docstring} airsspy.scheduler.Slurm.hold_all_pd_arrays
```

````

````{py:method} release_all_pd_arrays(user_name: typing.Optional[str] = None) -> None
:canonical: airsspy.scheduler.Slurm.release_all_pd_arrays

```{autodoc2-docstring} airsspy.scheduler.Slurm.release_all_pd_arrays
```

````

````{py:method} get_running_jobs(user_name: typing.Optional[str] = None) -> typing.Optional[list[str]]
:canonical: airsspy.scheduler.Slurm.get_running_jobs

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_running_jobs
```

````

````{py:method} get_pd_arrays(user_name: typing.Optional[str] = None) -> typing.Optional[list[str]]
:canonical: airsspy.scheduler.Slurm.get_pd_arrays

```{autodoc2-docstring} airsspy.scheduler.Slurm.get_pd_arrays
```

````

````{py:method} __bool__() -> bool
:canonical: airsspy.scheduler.Slurm.__bool__

```{autodoc2-docstring} airsspy.scheduler.Slurm.__bool__
```

````

````{py:method} __getitem__(key: str) -> typing.Optional[str]
:canonical: airsspy.scheduler.Slurm.__getitem__

```{autodoc2-docstring} airsspy.scheduler.Slurm.__getitem__
```

````

````{py:method} __contains__(key: str) -> bool
:canonical: airsspy.scheduler.Slurm.__contains__

```{autodoc2-docstring} airsspy.scheduler.Slurm.__contains__
```

````

`````