locigenesis/README.org

36 lines
832 B
Org Mode

* locigenesis
locigenesis is a tool that generates an immune repertoire and runs it through a sequence reader simulation tool, to generate sequencing errors.
** Installation
This project uses [[https://nixos.org/][Nix]] to ensure reproducible builds.
1. Install Nix (compatible with MacOS, Linux and [[https://docs.microsoft.com/en-us/windows/wsl/about][WSL]]):
#+begin_src shell
curl -L https://nixos.org/nix/install | sh
#+end_src
1. Clone the repository:
#+begin_src shell
git clone https://git.coolneng.duckdns.org/coolneng/locigenesis
#+end_src
3. Change the working directory to the project:
#+begin_src shell
cd locigenesis
#+end_src
4. Enter the nix-shell:
#+begin_src shell
nix-shell
#+end_src
After running these commands, you will find yourself in a shell that contains all the needed dependencies.
** Usage