Skip to content

Commit

Permalink
Update make help
Browse files Browse the repository at this point in the history
  • Loading branch information
karel-brinda committed Mar 17, 2024
1 parent 602ec07 commit 125de72
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 9 deletions.
16 changes: 12 additions & 4 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
.PHONY: all test help clean cleanall cluster download download_asms download_cobs match map checkformat report config conda
.PHONY: \
all test help clean cleanall \
conda download download_asms download_cobs match map \
config report \
cluster_slurm cluster_lsf cluster_lsf_test \
format checkformat

SHELL=/usr/bin/env bash -eo pipefail
DATETIME=$(shell date -u +"%Y_%m_%dT%H_%M_%S")
Expand Down Expand Up @@ -109,24 +114,27 @@ report: ## Generate Snakemake report
#############
## Cluster ##
#############

cluster_slurm: ## Submit to a SLURM cluster
sbatch \
-c 10 \
--mem=80GB \
-t 0-08:00:00 \
--wrap="make"

cluster_lsf: ## Submit to LSF cluster
scripts/check_if_config_is_ok_for_cluster_run.py
scripts/submit_lsf.sh

cluster_lsf_test: ## Submit the test pipeline to LSF cluster
scripts/check_if_config_is_ok_for_cluster_run.py
scripts/submit_lsf.sh test

cluster_lsf: ## Submit to LSF cluster
scripts/check_if_config_is_ok_for_cluster_run.py
scripts/submit_lsf.sh

####################
## For developers ##
####################

format: ## Reformat Python and Snakemake files
yapf -i */*.py
snakefmt Snakefile
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,6 @@ Here's a list of all implemented commands (to be executed as `make {command}`):
####################
# General commands #
####################

all Run everything (the default rule)
test Quick test using 3 batches
help Print help messages
Expand All @@ -263,13 +262,17 @@ Here's a list of all implemented commands (to be executed as `make {command}`):
#############
config Print configuration without comments
report Generate Snakemake report
########
# Misc #
########
###########
# Cluster #
###########
cluster_slurm Submit to a SLURM cluster
cluster_lsf_test Submit the test pipeline to LSF cluster
cluster_lsf Submit to LSF cluster
cluster_lsf_test Submit the test pipeline to LSF cluster
##################
# For developers #
##################
format Reformat Python and Snakemake files
checkformat Check source code format
```

*Note:* `make format` requires
Expand Down

0 comments on commit 125de72

Please sign in to comment.