Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
gordonkoehn committed Oct 18, 2023
1 parent e706f67 commit 9e9a7d0
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import pyggdrasil as yg
See [Contributing Guidelines](https://cbg-ethz.github.io/PYggdrasil/contributing/).
### Setting up the repository

To build package and maintain dependencies we use [Poetry](https://python-poetry.org/).
To build the package and maintain dependencies we use [Poetry](https://python-poetry.org/).
In particular, it's good to install it and become familiar with its basic functionalities by reading the documentation.

To set up the environment (together with development tools) run:
Expand Down Expand Up @@ -70,8 +70,8 @@ We recommend submitting small pull requests and starting with drafts outlining p

* The package code is in ``src/pyggdrasil/`` and is partitioned into subpackages.
* The unit tests are in ``tests/`` and the structure of this directory should reflect the one of the package.
* Experimental workflows are in ``workflows/``, with a description of how to set up the environment in ``workflows/README.md``
* Experimental workflows are in ``workflows/``, with a description of how to set up the [Conda](https://docs.conda.io/en/latest/) environment in ``workflows/README.md``

## Origin & Authorship
This package originates from [Gordon J Köhn](https://github.com/gordonkoehn)'s MSc Thesis: _[Quantifying MCMC Exploration of Tumour Progression Tree Spaces](TODO(Gordon)): add in link)_ in 2023 at ETH Zürich.
This package originates from [Gordon J Köhn](https://github.com/gordonkoehn)'s MSc Thesis: _[Quantifying MCMC Exploration of Tumour Progression Tree Spaces](TODO(Gordon): add in link)_ in 2023 at ETH Zürich.
[Paweł Czyż](https://pawel-czyz.github.io/) and Prof. Dr Niko Beerenwinkel supervised this project as part of the Computational Biology Group at the [Department of Biosystems Science and Engineering](https://www.bsse.ethz.ch/).
7 changes: 6 additions & 1 deletion workflows/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,12 @@ snakemake --dag mark00 | dot -Tpng > dag.png
```

## Environment
This project used `conda` to manage the environment.
Whilst we use [Poetry](https://python-poetry.org/) as a dependency manager, we recommend to used [Conda](https://docs.conda.io/en/latest/) to as the environment manager.

_PYggdrasil_'s dependencies are best installed via [Poetry](https://python-poetry.org/) in an envrioment created by [Conda](https://docs.conda.io/en/latest/).

This seperation allows to disect the dependencies of the package from the dependencies of the ``workflows``,
such as [snakemake](https://snakemake.readthedocs.io/en/stable/).

We recommend a setup via `mini-conda.`, i.e on linux:

Expand Down

0 comments on commit 9e9a7d0

Please sign in to comment.