From 8921c1c6f26b66184fe972b842967e60dff0571d Mon Sep 17 00:00:00 2001 From: Malte Lau Petersen Date: Mon, 1 Dec 2025 18:08:40 +0100 Subject: [PATCH 1/2] Specify dependencies using pyproject.toml "six" and "requests" are both implicit dependencies that a package manager will need to fetch --- pyproject.toml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 pyproject.toml diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..a5dc0c3 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,10 @@ +[project] +name = "stormdb" +version = "0.7.dev0" +description = "Tools for accessing StormDb @ CFIN" +readme = "README.md" +requires-python = ">=3.11" +dependencies = [ + "requests", + "six", +] From 227d6810ab817a386549b855fa9e1c9d07dc8662 Mon Sep 17 00:00:00 2001 From: Malte Lau Petersen Date: Tue, 2 Dec 2025 10:01:53 +0100 Subject: [PATCH 2/2] Add installation & usage for submit_to_cluster to README --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 4c7816c..a050501 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,39 @@ stormdb-python __NB! Help with documentation and examples needed!__ +Command line utility: `submit_to_cluster` +----------------------------------------- +Install with [uv](https://docs.astral.sh/uv/) by calling + +``` bash +uv tool install "stormdb @ https://github.com/meeg-cfin/stormdb-python.git" +``` + +which creates symlinks in your `~/.local/bin` that lets you use `submit_to_cluster` + +``` +usage: submit_to_cluster [-h] [-n N_THREADS] [-q QUEUE] [-m TOTAL_MEMORY] [-p PROJECT] [-w WORKING_DIR] [--noclean] exec_cmd + +positional arguments: + exec_cmd Full command to execute, in quotes (") + +options: + -h, --help show this help message and exit + -n N_THREADS, --n_threads N_THREADS + Number of threads to run per process. + -q QUEUE, --queue QUEUE + Name of queue to submit to + -m TOTAL_MEMORY, --total_memory TOTAL_MEMORY + Total amount of memory to request (max 1 thread). Format: M=megabytes, G=gigabytes (e.g. 30G). See docstring of + `ClusterJob` for details! + -p PROJECT, --project PROJECT + Name of project (or set MINDLABPROJ) + -w WORKING_DIR, --working_dir WORKING_DIR + Working directory for the job (default: cwd) + --noclean Do not clean up the qsub submission script. +``` + + Submodule: access -----------------