-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
46 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |