diff --git a/docs/faq.rst b/docs/faq.rst index 9a06519..47f6ae6 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -78,7 +78,7 @@ This can also be easily run using the Docker image, which already contains all o .. code-block:: bash - docker run -it --rm -v $PWD:$PWD -w $PWD aertslab/pyscenic:0.10.3 \ + docker run -it --rm -v $PWD:$PWD -w $PWD aertslab/pyscenic:0.12.1 \ python add_visualization.py \ --loom_input auc_mtx.loom \ --loom_output scenic_visualize.loom \ diff --git a/docs/installation.rst b/docs/installation.rst index cc0adf2..81cacae 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -72,7 +72,7 @@ A command line version of the tool is included. This tool is available after pro $ pyscenic -h usage: pyscenic [-h] {grn,add_cor,ctx,aucell} ... - Single-Cell rEgulatory Network Inference and Clustering (0.12.0) + Single-Cell rEgulatory Network Inference and Clustering (0.12.1) positional arguments: {grn,add_cor,ctx,aucell} @@ -114,12 +114,12 @@ Docker/Podman images are available at `Docker Hub pySCENIC`_ and `Docker Hub pyS .. code-block:: bash # pySCENIC CLI version (recommended). - docker pull aertslab/pyscenic:0.12.0 - podman pull docker://aertslab/pyscenic:0.12.0 + docker pull aertslab/pyscenic:0.12.1 + podman pull docker://aertslab/pyscenic:0.12.1 # pySCENIC CLI version + ipython kernel + scanpy. - docker pull aertslab/pyscenic_scanpy:0.12.0_1.9.1 - podman pull docker://aertslab/pyscenic_scanpy:0.12.0_1.9.1 + docker pull aertslab/pyscenic_scanpy:0.12.1_1.9.1 + podman pull docker://aertslab/pyscenic_scanpy:0.12.1_1.9.1 To run pySCENIC using Docker/Podman, use the following three steps. A mount point (or more than one) needs to be specified, which contains the input data and necessary resources). @@ -128,7 +128,7 @@ A mount point (or more than one) needs to be specified, which contains the input docker run -it --rm \ -v /data:/data \ - aertslab/pyscenic:0.12.0 pyscenic grn \ + aertslab/pyscenic:0.12.1 pyscenic grn \ --num_workers 6 \ -o /data/expr_mat.adjacencies.tsv \ /data/expr_mat.tsv \ @@ -136,7 +136,7 @@ A mount point (or more than one) needs to be specified, which contains the input docker run -it --rm \ -v /data:/data \ - aertslab/pyscenic:0.12.0 pyscenic ctx \ + aertslab/pyscenic:0.12.1 pyscenic ctx \ /data/expr_mat.adjacencies.tsv \ /data/hg19-tss-centered-5kb-7species.mc9nr.genes_vs_motifs.rankings.feather \ /data/hg19-tss-centered-10kb-7species.mc9nr.genes_vs_motifs.rankings.feather \ @@ -148,7 +148,7 @@ A mount point (or more than one) needs to be specified, which contains the input docker run -it --rm \ -v /data:/data \ - aertslab/pyscenic:0.12.0 pyscenic aucell \ + aertslab/pyscenic:0.12.1 pyscenic aucell \ /data/expr_mat.tsv \ /data/regulons.csv \ -o /data/auc_mtx.csv \ @@ -162,19 +162,19 @@ Singularity/Apptainer images can be build from the Docker Hub image as source: .. code-block:: bash # pySCENIC CLI version. - singularity build aertslab-pyscenic-0.12.0.sif docker://aertslab/pyscenic:0.12.0 - apptainer build aertslab-pyscenic-0.12.0.sif docker://aertslab/pyscenic:0.12.0 + singularity build aertslab-pyscenic-0.12.1.sif docker://aertslab/pyscenic:0.12.1 + apptainer build aertslab-pyscenic-0.12.1.sif docker://aertslab/pyscenic:0.12.1 # pySCENIC CLI version + ipython kernel + scanpy. - singularity build aertslab-pyscenic-scanpy-0.12.0-1.9.1.sif docker://aertslab/pyscenic_scanpy:0.12.0_1.9.1 - apptainer build aertslab-pyscenic-0.12.0-1.9.1.sif docker://aertslab/pyscenic_scanpy:0.12.0_1.9.1 + singularity build aertslab-pyscenic-scanpy-0.12.1-1.9.1.sif docker://aertslab/pyscenic_scanpy:0.12.1_1.9.1 + apptainer build aertslab-pyscenic-0.12.1-1.9.1.sif docker://aertslab/pyscenic_scanpy:0.12.1_1.9.1 To run pySCENIC with Singularity/Apptainer, the usage is very similar to that of Docker/Podman. .. code-block:: bash - singularity run aertslab-pyscenic-0.12.0.sif \ + singularity run aertslab-pyscenic-0.12.1.sif \ pyscenic grn \ -B /data:/data --num_workers 6 \ diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst index 01a0f27..fc0e134 100644 --- a/docs/releasenotes.rst +++ b/docs/releasenotes.rst @@ -1,6 +1,13 @@ Release Notes ============= +0.12.1 | 2022-11-21 +^^^^^^^^^^^^^^^^^^^ + +* Add support for running arboreto_with_multiprocessing.py with spawn instead of fork as multiprocessing method.Pool +* Use ravel instead of flatten to avoid unnecessary memory copy in aucell +* Update Docker image file and add separated Docker file for pySCENIC with scanpy. + 0.12.0 | 2022-08-16 ^^^^^^^^^^^^^^^^^^^ diff --git a/pyscenic_with_scanpy.Dockerfile b/pyscenic_with_scanpy.Dockerfile index a9ff1ff..ebbad82 100644 --- a/pyscenic_with_scanpy.Dockerfile +++ b/pyscenic_with_scanpy.Dockerfile @@ -1,4 +1,4 @@ -FROM aertslab/pyscenic:0.12.0 AS compile-image +FROM aertslab/pyscenic:0.12.1 AS compile-image ENV DEBIAN_FRONTEND=noninteractive @@ -11,7 +11,7 @@ RUN apt-get update && \ COPY requirements_docker_with_scanpy.txt /tmp/ RUN pip install --no-cache-dir -r /tmp/requirements_docker_with_scanpy.txt -FROM aertslab/pyscenic:0.12.0 AS build-image +FROM aertslab/pyscenic:0.12.1 AS build-image RUN apt-get -y update && \ apt-get -y --no-install-recommends install \