Skip to content

Commit

Permalink
update readme and rerun tests
Browse files Browse the repository at this point in the history
  • Loading branch information
ketringjoni committed Dec 14, 2023
1 parent b64fc47 commit a634e02
Show file tree
Hide file tree
Showing 3 changed files with 203 additions and 214 deletions.
45 changes: 17 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,30 @@


## Installation

**Download SuPreMo by:**
```shell
git clone https://github.com/ketringjoni/SuPreMo.git
```

**Requirements:**
- Overall
* Python
* Pysam
* Pandas
* Numpy
* Pathlib
* Biopython
- Only for SuPreMo-Akita
* Akita, Basenji, and their dependencies
- Only for walkthroughs
* Jupyter
* Matplotlib

**For SuPreMo**, we recommend creating a conda environment with the requirements outlined above or using [get_seq_env.yml](https://github.com/ketringjoni/SuPreMo/blob/main/get_seq_env.yml).
For **SuPreMo**, we recommend creating a conda environment with Python, Pysam, Pandas, Numpy, Pathlib, and Biopython or using [get_seq_env.yml](https://github.com/ketringjoni/SuPreMo/blob/main/get_seq_env.yml).

**For SuPreMo-Akita**, we recommend creating a conda environment following the steps outlined below. Compatible package versions are shown in [get_Akita_scores_env.yml](https://github.com/ketringjoni/SuPreMo/blob/main/get_Akita_scores_env.yml).
For **SuPreMo-Akita**, we recommend creating a conda environment following the steps outlined below. Compatible package versions are shown in [get_Akita_scores_env.yml](https://github.com/ketringjoni/SuPreMo/blob/main/get_Akita_scores_env.yml).

1. Create conda environment with python=3.10 numpy scipy pandas jupyter tensorflow
2. Install [basenji](https://github.com/calico/basenji) with no dependencies, then set the following environmental variables.
* python setup.py develop --no-deps
* export BASENJIDIR=~/basenji
* export PATH=$BASENJIDIR/bin:$PATH
* export PYTHONPATH=$BASENJIDIR/bin:$PYTHONPATH
1. Create conda environment with python=3.10 numpy scipy pandas jupyter tensorflow.
2. Install [basenji](https://github.com/calico/basenji) with no dependencies and set environmental variables.
```shell
python setup.py develop --no-deps
export BASENJIDIR=~/basenji
export PATH=$BASENJIDIR/bin:$PATH
export PYTHONPATH=$BASENJIDIR/bin:$PYTHONPATH
```
3. Install the rest of the dependencies using pip: astropy, protobuf==3.19, tensorflow-io-gcs-filesystem, patsy, libclang, Cython, cooltools, biopython, pathlib, natsort.


To test that all the necessary packages are properly installed, run [testing_packages.py](https://github.com/ketringjoni/SuPreMo/blob/main/scripts/testing_packages.py).


**Download SuPreMo by:**
```shell
git clone https://github.com/ketringjoni/SuPreMo.git
```

For the tutorials, Jupyter and Matplotlib are also needed.



Expand Down
Loading

0 comments on commit a634e02

Please sign in to comment.