Skip to content

Commit

Permalink
upped version, slight readability fix in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jhn-nt committed Oct 2, 2024
1 parent b4f3d34 commit 892fa35
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# DockSing
## CLI Utility for deployment of containerized jobs on SLURM HPCs
![python](https://img.shields.io/badge/python->=3.10-blue)
![pypi](https://img.shields.io/badge/pypi-0.2.25-blue)

### Installation
_Requirements_:
* _Local_: [Docker](https://www.docker.com/products/docker-desktop/)
* _Local_: `python>=3.10`
* _Remote_: [Singularity](https://docs.sylabs.io/guides/2.6/user-guide/index.html)

On your _local_ host run:
```bash
pip install docksing
Expand Down Expand Up @@ -148,10 +155,10 @@ docksing --ssh username@hostname --config config.yaml --stream
```

### Supported Compose Specification
- workdir
- environment
- volumes
- commands
- `workdir`
- `environment`
- `volumes`
- `commands`

### Design Notes
DockSing is developed with the aim of maintaining the highest adherence to existing standards with the lowest code overhead possible, in order to retrospectively preserve interoperability with docker, singularity and SLURM documentations.
Expand All @@ -160,7 +167,4 @@ To squeeze the most out of DockSing it is advisable to have good proficiency wit
### Limitations
Docksing was tested on a Windows Linux Subsytem, milage may very on other settings.

### Requirements
* _Local_: [Docker](https://www.docker.com/products/docker-desktop/)
* _Local_: `python>3.10`
* _Remote_: [Singularity](https://docs.sylabs.io/guides/2.6/user-guide/index.html)

2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name="docksing",
version="0.2.24",
version="0.2.25",
description="CLI Utility for deployment of containerized jobs on SLURM HPC ",
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down

0 comments on commit 892fa35

Please sign in to comment.