Metadata-Version: 2.4
Name: capsuli
Version: 0.1.0
Summary: A library for starting and managing processes locally and on HPC clusters
Author-email: Lourens Veen <l.veen@esciencecenter.nl>
License-Expression: Apache-2.0
Project-URL: Repository, https://github.com/NaturalHPC/capsuli
Project-URL: Issues, https://github.com/NaturalHPC/capsuli/issues
Project-URL: Changelog, https://github.com/NaturalHPC/capsuli/CHANGELOG.md
Project-URL: ReadTheDocs, https://capsuli.readthedocs.io
Keywords: HPC,processes,monitoring
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
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 :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil
Requires-Dist: typing_extensions
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: coverage[toml]; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: sphinx; extra == "dev"
Requires-Dist: sphinx_rtd_theme; extra == "dev"
Requires-Dist: sphinx-autoapi; extra == "dev"
Requires-Dist: tox; extra == "dev"
Provides-Extra: docs
Requires-Dist: myst_parser; extra == "docs"
Requires-Dist: pytest; extra == "docs"
Requires-Dist: recommonmark; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: sphinx-autoapi; extra == "docs"
Dynamic: license-file

# Capsuli

[![Documentation](https://readthedocs.org/projects/capsuli/badge/?version=latest)](https://capsuli.readthedocs.io/en/latest/?badge=latest) [![CI](https://github.com/NaturalHPC/capsuli/actions/workflows/test.yml/badge.svg)](https://github.com/NaturalHPC/capsuli/actions/workflows/test.yml) [![CFF](https://github.com/NaturalHPC/capsuli/actions/workflows/cffconvert.yml/badge.svg)](https://github.com/NaturalHPC/capsuli/actions/workflows/cffconvert.yml)

Capsuli is the Cluster Allocation Process SUpervision LIbrary. It scans available
compute resources and returns a description of them, then lets you select a subset and
start a program on that subset. Programs can be single- or multithreaded, or MPI
parallel. Processes are monitored, output can be redirected, and exit status is
recorded. Works locally and inside a Slurm allocation

See the [Capsuli documentation](https://capsuli.readthedocs.io/en/latest) to get
started.

## Legal

Capsuli is Copyright 2018-2026 Netherlands eScience Center, University of Amsterdam,
Utrecht University.

Licensed under the Apache License 2.0. See LICENSE for the terms.

