Update to version 2.0.0

.github/workflows/dev_docs.yaml

@@ -0,0 +1,31 @@
+name: Build/Publish Develop Docs 
+on:
+  push:
+    tags-ignore: ['**']
+    branches:
+      - dev
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache 
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mike
+      - run: mike deploy --push Dev

.github/workflows/main.yml

@@ -1,16 +1,18 @@
-name: ci 
+name: Build/Publish Latest Release Docs
+
 on:
-  push:
-    branches:
-      - main
-      - docs_v2
+  release:
+    types: [published]
+
 permissions:
   contents: write
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - name: Configure Git Credentials
         run: |
           git config user.name github-actions[bot]
@@ -25,5 +27,5 @@ jobs:
           path: .cache 
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material 
-      - run: mkdocs gh-deploy --force
+      - run: pip install mkdocs-material mike
+      - run: mike deploy --push --update-aliases ${{ github.event.release.tag_name }} latest

Dockerfile

@@ -0,0 +1,15 @@
+FROM mambaorg/micromamba:latest
+
+USER $MAMBA_USER
+
+COPY --chown=$MAMBA_USER:$MAMBA_USER docker_env.yml /tmp/env.yml
+RUN micromamba install -y -n base -f /tmp/env.yml && \
+    micromamba clean --all --yes
+
+COPY --chown=$MAMBA_USER:$MAMBA_USER . /tmp
+ARG MAMBA_DOCKERFILE_ACTIVATE=1
+RUN python -m pip install /tmp
+
+RUN rm -rf /tmp/*
+
+ENV PATH=${PATH}:/opt/conda/bin

README.md

@@ -1,95 +1,31 @@
 # Small RNA Pipeline for the Hunt Lab
 
-This repository contains the code for the pipeline used to carry out sRNA-seq ananlysis in Vicky Hunt's lab. For usage and the tasks the pipeline can run, see the documentation, avalible in PDF, DOCX and HTML format in the `docs/` directory in the repository. 
+This repository contains the code for the pipeline used to carry out sRNA-seq ananlysis in Vicky Hunt's lab. This is version 2 for version 1 see the `v1.x` branch.
 
-Note this software is very new, please report any bugs found to the GitHub bug tracker. Also note that it currently does not support GZipped input files, though support will be considered in the future if it is wanted enough.
+Documentation and information on how to install and run this pipeline can be found [here](https://vicky-hunt-lab.github.io/HuntLab-smallRNA/latest). Please report any bugs found or ask any other questions relating to the pipeline on the GitHub bug tracker.
 
 ## Installation
 
-Stable versions of the pipeline can be downloaded from releases on GitHub, unstable can be cloned using `git`.
+A containerised version of the pipeline is provided to allow for easy installation. Apptainer is recommended, as it allows for running with relative paths.
 
-It is recommended to use conda to install this pipeline. To perform the installation, ensure conda is installed on the machine, navigate to the directory containing the code and `environment.yml` file, then run:
+### Installing with Apptainer
+Create a SIF file with the code by running the following:
 
 ```
-$ conda env create -f environment.yml
+$ apptainer pull hlsmallrna.sif docker://kieranr51/huntlab-smallrna
 ```
 
-This will create a conda environment called huntlab-smallrna. This can then be activated each time you want to use the software with the command:
+To test it works try displaying the help message with the following command:
 
 ```
-$ conda activate huntlab-smallrna
+$ apptainer run hlsmallrna.sif hlsmallrna --help
 ```
 
-By default this provides the hlsmallrna executable. This provides all of the tasks listed in the documentation, each one can be run by typing hlsmallrna followed by the name and options for the task.
+If this displays the help message, you are good to go. All subsequent commands can be run with:
 
+```
+$ apptainer run -B $HOME:$HOME hlsmallrna.sif [COMMAND]
+```
 
-## Configuration File
-
-This pipeline can be configured with a "config.toml" file. This file is written in ["Tom's Obvious, Minimal Language"](https://toml.io/en/) (TOML) format, which is a common format for configeration. This file is split into multiple sections, with headers in square brackets. Valid keys are shown in the example file below. (Note lines starting with a # are comments like in python). An example is below, see the documentation for more comprihensive instructions.
-
-```toml
-# Configeration that doesn't fit anywhere else
-[general]
-# path to the directory to put the output in
-output_directory = "/path/to/output"
-
-# Number of threads to pass to any program that allows for multiprocessing
-threads = 8
-
-# This section contains subsitues for optional command line arguments
-[command]
-# for process command
-adapter = "ACGTTTTTT"
-front = "TTTTTACG"
-anywhere = ""
-cutoff = 25
-
-# for sort command
-min_length = 7
-max_length = 35
-
-# for unitas command
-refseq = [
-    "/path/to/refseq1",
-    "/path/to/refseq2"
-]
-species = "x"
-
-# for targetid command
-target_files = [
-    "/path/to/targetseq1",
-    "/path/to/targetseq2"
-]
-min_seq_length = 9
-num_mismatches = 0
-
-# Section containing configeration for each of the exteranl programs called while in use
-[cli-tools]
-[cli-tools.trim]
-trim_pass_threads = true
-path_to_trim = "cutadapt"
-trim_type = ""
-trim_params = []
-
-[cli-tools.fastqc]
-fastqc_pass_threads = true
-path_to_fastqc = "fastqc"
-fastqc_params = []
-
-[cli-tools.unitas]
-unitas_pass_threads = true
-path_to_unitas = "unitas"
-unitas_params = []
-
-[cli-tools.bowtie2]
-bowtie2_pass_threads = true
-path_to_bowtie2 = "bowtie2"
-bowtie2_params = []
-path_to_bowtie2_build = "bowtie2-build"
-bowtie2_build_params = []
-
-[cli-tools.samtools]
-path_to_samtools = "samtools"
-samtools_view_params = ["-h", "-F", "256", "-F", "4"]
-samtools_fastq_params = []
-```
+If this is not possible, other methods of installation are covered in the documentation at:
+[https://vicky-hunt-lab.github.io/HuntLab-smallRNA/latest/installation/](https://vicky-hunt-lab.github.io/HuntLab-smallRNA/latest/installation/)