Metadata-Version: 2.4
Name: cfin-hpc-tools
Version: 0.3.0b1
Summary: Some general grid-engine HPC tools, mainly geared for UCL systems but should be generalisable. Note this is not a UCL endorsed package.
Author-email: Chris Finan <c.finan@ucl.ac.uk>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://cfinan.gitlab.io/cluster
Project-URL: Repository, https://gitlab.com/cfinan/cluster
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: <3.14,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: terminaltables>=3.1
Requires-Dist: cfin-pyaddons
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-dependency; extra == "dev"
Requires-Dist: pytest-randomly; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: bump2version; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# hpc-tools

__version__: `0.3.0b1`

`hpc-tools` helps create and submit HPC job arrays. Grid Engine is the default
scheduler, with Slurm, LSF, and PBS Pro/OpenPBS adapters also available.

## Install

Install from PyPI:

```bash
python -m pip install cfin-hpc-tools
```

Or install with conda:

```bash
conda install -c cfin cfin-hpc-tools
```

For an editable developer install:

```bash
git clone git@gitlab.com:cfinan/cluster.git
cd cluster
python -m pip install -e .
```

## Documentation

Start with the getting-started guide in the GitLab Pages documentation:

https://cfinan.gitlab.io/cluster/

The same source page is maintained in
[`docs/source/index.rst`](docs/source/index.rst).
