Skip to content

Commit

Permalink
Barely enough instructions for the reviewers
Browse files Browse the repository at this point in the history
  • Loading branch information
DrYak committed Oct 15, 2022
1 parent db12806 commit e93a9c5
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# LolliPop
LolliPop - a tool for Deconvolution for Wastewater Genomics

## Installation

We recommend installting the bioconda package:

```bash
conda install lollipop
```

## Usage

From notebooks:

```python
from lollipop import *
```

See [notebook WwSmoothingKernel.ipynb](RECOMBpaper/WwSmoothingKernel.ipynb)
in directory [RECOMBpaper/](RECOMBpaper/)

Command lins:

...comming soon...
14 changes: 14 additions & 0 deletions RECOMBpaper/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Notebooks

This directory contains the Notebooks that have been used to generate the plots for the submission to Recomb 2003.

## Jupyter kernel

To install the `lollipop` kernel necessary for [notebook WwSmoothingKernel.ipynb](WwSmoothingKernel.ipynb),
you can also use conda:

```bash
conda env create -f conda_ipylollipop_env.yaml
conda activate ipylollipop
python -m ipykernel install --user --name=lollipop
```

0 comments on commit e93a9c5

Please sign in to comment.