Skip to content

Commit

Permalink
doc: Add basic install/use info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kdm9 committed Apr 7, 2021
1 parent d9c5dbd commit f8c02f5
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,29 @@ It should contain a fully working example workflow.

![Acanthophis, the most beautiful and badass of snakes](.github/logo.jpg)

## Installation & Use

```bash
# create conda env, activate it
conda create -n someproject python snakemake pip
conda activate someproject

# install acanthophis itself
pip install acanthophis

# generate boilerplate
acanthophis-init /path/to/someproject/

# edit config.yml to suit your project
vim config.yml

# run snakemake
snakemake -j 16 -p --use-conda --conda-frontend mamba --ri
# or on a cluster, see acanthophis-init --list-available-profiles
snakemake --profile ./ebio-cluster/
```


## About & Authors

This is an amalgamation of several pipelines developed between the [Weigel Group, MPI DB, Tübingen, DE](https://weigelworld.org), the [Warthmann Group, IAEA/FAO PBGL, Seibersdorf, AT](http://warthmann.com) and the [Borevitz Group, ANU, Canberra, AU](https://borevitzlab.anu.edu.au). This amalgamation authored by Dr. K. D. Murray, original code primary by K. D. Murray, Norman Warthmann, and Ilja Bezrukov, with contributions from others at the aforementioned institutes.
Expand Down

0 comments on commit f8c02f5

Please sign in to comment.