Skip to content

Commit

Permalink
add app devops guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
lpantano committed Oct 11, 2024
1 parent 7a0b7c8 commit c8a53f6
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/devops.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@

Content ![](https://img.shields.io/badge/status-WorkInProgress-yellow)

## App development

- Use HBC or bcbio organization
- Private repo prior to release
- Test data needs to be part of the code
- README to explain how to use the test data
- First release should be prior to client
- Must be usable at First release
- At least one other person to review and approve
- After that main branch get blocked and version numbers start at 1.0.0
- Then start dev branch
- Each time we merge a Pull request, we need to make a release
- Publish on Posit connect with a new name that matches the version

## Data management

Expand Down
26 changes: 25 additions & 1 deletion docs/pipelines.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction to HCBC pipelines

Content ![](https://img.shields.io/badge/status-WorkInProgress-yellow)
Content - ![](https://img.shields.io/badge/status-WorkInProgress-yellow)

## Nextflow in Seqera platform

Expand Down Expand Up @@ -32,6 +32,30 @@ You can add more columns to this file with more metadata, and use this file as t

## Nextflow in O2

Nextflow is available at `/n/app/bcbio/nextflow/nextflow`.
Singularity containers at available at `/n/app/singularity/containers/shared/bcbio/`.

An example of batch script is:

```
#!/bin/bash
#SBATCH --job-name=Nextflow # Job name
#SBATCH --partition=priority # Partition name
#SBATCH --time=1-23:59 # Runtime in D-HH:MM format
#SBATCH --nodes=1 # Number of nodes (keep at 1)
#SBATCH --ntasks=1 # Number of tasks per node (keep at 1)
#SBATCH --cpus-per-task=8 # CPU cores requested per task (change for threaded jobs)
#SBATCH --mem=128G # Memory needed per node (total)
#SBATCH --error=jobid_%j.err # File to which STDERR will be written, including job ID
#SBATCH --output=jobid_%j.out # File to which STDOUT will be written, including job ID
#SBATCH --mail-type=ALL # Type of email notification (BEGIN, END, FAIL, ALL)
module load java/jdk-21.0.2
export NXF_APPTAINER_CACHEDIR=/n/app/singularity/containers/shared/bcbio/nf-core-rnaseq-3.14.0
export NXF_SINGULARITY_LIBRARYDIR=/n/app/singularity/containers/shared/bcbio/nf-core-rnaseq-3.14.0
```

### RNAseq

Example of running in single node Nextflow/nf-core/rnaseq in O2.
Expand Down

0 comments on commit c8a53f6

Please sign in to comment.