0.0.4

Author: John Major

README.md

@@ -1,5 +1,26 @@
-# Snakemake executor plugin: pcluster-slurm
+# Snakemake executor plugin: pcluster-slurm v_0.0.4_
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/snakemake/snakemake-executor-plugin-pcluster-slurm)
+# Snakemake Executor Plugins (generally)
+[Snakemake plugin catalog docs](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor).
 
-For documentation, see the [Snakemake plugin catalog PLACEHOLDER for pcluster-slurm](https://snakemake.github.io/snakemake-plugin-catalog/plugins/executor/pcluster-slurm.html).
+## `pcluster-slurm` plugin
+### AWS Parallel Cluster, `pcluster` `slurm`
+[AWS Parallel Cluster](https://aws.amazon.com/hpc/parallelcluster/) is a framework to deploy and manage dynamically scalable HPC clusters on AWS, running SLURM as the batch system, and `pcluster` manages all of the creating, configuring, and deleting of the cluster compute nodes. Nodes may be spot or dedicated.  **note**, the `AWS Parallel Cluster` port of slurm has a few small, but critical differences from the standard slurm distribution.  This plugin enables using slurm from pcluster head and compute nodes via snakemake `>=v8.*`.
+
+
+# Pre-requisites
+## Snakemake >=8.*
+### Conda
+```bash
+conda create -n snakemake -c conda-forge -c bioconda snakemake==8.20.6
+conda activate snakemake
+```
+
+# Installation (pip)
+_from an environment with snakemake and pip installed_
+```bash
+pip install snakemake-executor-plugin-pcluster-slurm
+```
+
+# More Documentation Pending For:
+## How slurm uses `--comment` to tag resources created by the autoscaling cluster to tracke and mnage budgets.

docs/further.md

@@ -2,7 +2,7 @@
 
 ## The general Idea
 
-Upon creating a valid AWS Parallel Cluster (and one which uses slurm as the scheduler), to use this plugin: _a._ log in to your cluster's head node, _b._ activate your snakemake environment as usual (which should also have snakemake-executor-plugin-pcluster-slurm pip installed), and run a snakemake workflow with --executor pcluster-slurm. Snakemake will then submit your jobs as cluster jobs & `pcluster slurm` will manage creating compute nodes, bidding on them, managing budget constraints, spinning them down, etc. **It is magic really.**
+Upon creating a valid AWS Parallel Cluster (and one which uses slurm as the scheduler), to use this plugin: _a._ log in to your cluster's head node, _b._ activate your snakemake environment as usual (which should also have `snakemake-executor-plugin-pcluster-slurm` pip installed), and run a snakemake workflow with `--executor pcluster-slurm`. Snakemake will then submit your jobs as cluster jobs & `pcluster slurm` will manage creating compute nodes, bidding on them, managing budget constraints, spinning them down, etc. **It is magic really.**
 
 ## A Few Important `pcluster` `slurm` Peculiarities
 

examples/pcluster_slurm_snakemake7_config.yaml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snakemake-executor-plugin-pcluster-slurm"
-version = "0.0.3"
+version = "0.0.4"
 description = "A Snakemake executor plugin for submitting jobs to an AWS Parallel Cluster (pcluster) SLURM cluster."
 authors = [
     "John Major <[email protected]>",