diff --git a/README.md b/README.md index 8f1210f..44dd02d 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,21 @@ Slurm Manager

-# slurm_manager +# bec-slurm-manager Submit Slurm jobs through slurmrestd and receive live logs, status, and heartbeats through Redis. ## Setup ```bash -pip install -e . +pip install bec-slurm-manager cp .env.example .env ``` Set `SLURM_JWT` in your local `.env` file. The example contains the RA REST URL and API version. This credential file is ignored by Git and never uploaded. The submitter needs access to slurmrestd and Redis. +For development from a checkout, install with `pip install -e '.[dev]'`. ## Simple job diff --git a/pyproject.toml b/pyproject.toml index 9086c9b..abd73c2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["hatchling"] build-backend = "hatchling.build" [project] -name = "slurm_manager" +name = "bec-slurm-manager" version = "1.0.0" description = "A tool for managing slurm jobs." requires-python = ">=3.11"