Skip to content

Commit

Permalink
DOC: Update docs and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Vini2 committed Apr 22, 2024
1 parent eda887c commit 91397b4
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 8 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,6 @@ GraphBin2 is an extension of [GraphBin](https://github.com/Vini2/GraphBin) which

## Getting Started

### Dependencies
GraphBin2 requires Python 3.7 or higher (tested on Python 3.7.4). You will need the following python packages installed. Versions tested on are listed as well.
* [Biopython](https://biopython.org/) - version 1.74
* [python-igraph](https://igraph.org/python/) - version 0.7.1
* [tqdm](https://github.com/tqdm/tqdm) - version 4.36.1
* [scipy](https://scipy.org/)
* [click](https://click.palletsprojects.com/)

### Downloading GraphBin2
You can download the latest release of GraphBin2 from [Releases](https://github.com/Vini2/GraphBin2/releases) or clone the GraphBin2 repository to your machine.

Expand Down
46 changes: 46 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Setting up GraphBin2

## Downloading GraphBin2

You can download the latest release of GraphBin2 from [Releases](https://github.com/Vini2/GraphBin2/releases) or clone the GraphBin2 repository to your machine.

```bash
git clone https://github.com/Vini2/GraphBin2.git
```

If you have downloaded the latest release, you will have to extract the files using the following command.

```bash
unzip [file_name].zip
```

Now go in to the GraphBin2 folder using the command

```bash
cd GraphBin2/
```

## Setting up the environment

We recommend that you use [Conda](https://docs.conda.io/en/latest/) to run GraphBin2. You can download [Anaconda](https://www.anaconda.com/distribution/) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html) which contains Conda.

Once you have installed Conda, make sure you are in the GraphBin2 folder. Now run the following commands to create a Conda environment and activate it to run GraphBin2.

```bash
conda env create -f environment.yml
conda activate graphbin2
```

Now install GraphBin2 using the following command.

```bash
flit install
```

Now you are ready to run GraphBin2.

If you want to switch back to your normal environment, run the following command.

```bash
conda deactivate
```

0 comments on commit 91397b4

Please sign in to comment.