diff options
| author | pjotrp | 2026-03-25 09:46:47 +0100 |
|---|---|---|
| committer | pjotrp | 2026-03-25 09:46:47 +0100 |
| commit | 7a198d88b73583d790837f2a9c2e65cf47643d65 (patch) | |
| tree | b8d66942af090b897fde12336ecd6316bc34e846 | |
| parent | fcecde220d5ae02aa9c18520dcf3ccf6f2e64b15 (diff) | |
| download | guix-bioinformatics-7a198d88b73583d790837f2a9c2e65cf47643d65.tar.gz | |
Updated README
| -rw-r--r-- | README.org | 47 |
1 files changed, 15 insertions, 32 deletions
diff --git a/README.org b/README.org index 32164bb..c599a31 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,7 @@ * guix-bioinformatics -IMPORTANT: this repository has moved to https://git.genenetwork.org/guix-bioinformatics/! +IMPORTANT: this repository lives at https://git.genenetwork.org/guix-bioinformatics/! +Older packages have been moved to https://git.genenetwork.org/guix-bioinformatics-past/. Bioinformatics packages for Guix that are used in https://genenetwork.org/ and some other places. See Guix documentation and [[https://gitlab.com/pjotrp/guix-notes/blob/master/HACKING.org][Guix notes]] for @@ -18,53 +19,35 @@ To easily use the packages from this repo, simply add it to your [[https://guix.gnu.org/manual/en/html_node/Channels.html][here]]: #+BEGIN_SRC scheme + ;; channels.scm (list (channel (name 'gn-bioinformatics) (url "https://git.genenetwork.org/guix-bioinformatics") (branch "master"))) #+END_SRC -and run /guix pull/ like normal to update your software. This is the -recommended way to use the software from this repository and the code -snippets in this README assume you have done so. In order to maintain -stability, the guix-bioinformatics channel depends on a specific -commit of upstream Guix. So, it is recommended to isolate use of the -guix-bioinformatics channel in a separate /guix pull/ profile. That is described [[https://issues.genenetwork.org/topics/guix-profiles][here]]. +The channel file actually accesses https://git.genenetwork.org/guix-bioinformatics/tree/.guix-channel which pulls other channels and fixates the hashes. -If you want to make changes to the packages in this repo you can set -the GUIX_PACKAGE_PATH to point to the root of this directory -before running Guix. E.g. +and run /guix pull/ like normal to update your software. E.g. -#+BEGIN_SRC bash - git clone https://git.genenetwork.org/guix-bioinformatics/guix-bioinformatics.git - git clone https://gitlab.inria.fr/guix-hpc/guix-past.git - export GUIX_PACKAGE_PATH=$PWD/guix-bioinformatics/:$PWD/guix-past/modules - guix package -A cwl +#+BEGIN_SRC sh + guix pull --url=https://codeberg.org/guix/guix -p ~/opt/guix-b0fa1dc --commit=b0fa1dc --channels=channels.scm #+END_SRC -or using a checked out Guix repo with - -: env GUIX_PACKAGE_PATH=$genenetwork/guix-bioinformatics/ ./pre-inst-env guix package -A cwl - -Some (or most) of these package definitions should make it upstream -into the Guix repository when tested and stable. +(the commit hash can be found from the guix you want to run with /guix -V/, it speeds up installation and makes it reproducible). -* Module system +The latest channel file that is used by our CI/CD you can find at https://ci.genenetwork.org/channels.scm. -For those who think they need modules: install the module environment -with +This is the recommended way to use the software from this repository and the code snippets in this README assume you have done so. In order to maintain stability, the guix-bioinformatics channel depends on a specific commit of upstream Guix. So, it is recommended to isolate use of the guix-bioinformatics channel in a separate /guix pull/ profile. That is described [[https://issues.genenetwork.org/topics/guix-profiles][here]]. +If you want to make changes to the packages in this repo you can set the GUIX_PACKAGE_PATH to point to the root of this directory before running Guix. E.g. #+BEGIN_SRC bash - guix pull - guix package -i environment-modules - - modulecmd --version - VERSION=3.2.10 - DATE=2012-12-21 + git clone https://git.genenetwork.org/guix-bioinformatics/guix-bioinformatics.git + git clone https://gitlab.inria.fr/guix-hpc/guix-past.git + export GUIX_PACKAGE_PATH=$PWD/guix-bioinformatics/:$PWD/guix-past/modules + guix package -A cwl #+END_SRC -Note that Guix supercedes module functionality! - * Development tips ** Override individual packages |
