Skip to content

Commit

Permalink
Improve INSTALL.md; remove apt update from install-apt.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
akotlar committed Sep 7, 2023
1 parent 6dbf870 commit 65f87d8
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 17 deletions.
53 changes: 38 additions & 15 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# Bystro installation

For most users, we recommend not installing the software, and using https://bystro.io, where the software is hosted

The web app provides full functionality for any size experiment (up to 890GB uncompressed/129GB compressed tested), a convenient search interface, and excellent performance
The web app provides full functionality for any size experiment, a convenient search interface, and excellent performance

## Docker
# Installing Bystro using Docker

###### The recommended way to use Bystro on the command line

Expand All @@ -19,29 +17,54 @@ docker run bystro bystro-annotate.pl #Annotate
docker run bystro bystro-build.pl #Build
```

## Installation on RPM-based distros
# Direct (non-Docker) installation

###### (Fedora, Redhat, Centos, openSUSE, Mandriva)
There are 2 components to Bystro:
1. The Bystro annotator: a Perl program accessed through the command line (via bin/bystro-*)
2. The Bystro Python package: where the rest of Bystro's functionality lives (statistics, proteomics, etc).

1. `git clone https://github.com/akotlar/bystro.git && cd bystro && source ./install-rpm.sh`
## Installing the Bystro annotator (Perl/cli)

##### (Fedora, Redhat, Centos, openSUSE, Mandriva)

## Installation on MacOS
1. `git clone https://github.com/akotlar/bystro.git && cd bystro && source ./install-rpm.sh`

###### (tested on HighSierra, interactive)
##### MacOS (tested on HighSierra, interactive)

1. `git clone https://github.com/akotlar/bystro.git && cd bystro && source ./install-mac.sh`

## Installation on Debian systems
##### Ubuntu
1. Ensure that packages are up to date (`sudo apt update`), or that you are satisified with the state of package versions.
2. `git clone https://github.com/akotlar/bystro.git && cd bystro && source ./install-apt.sh`
- Please note that this installation script requires root priveleges, in order to install system dependencies

## Installing the Bystro Python libraries and cli tools

We recommend using Miniconda to manage Bystro Python dependencies: https://docs.conda.io/projects/miniconda/en/latest/

###### (Ubuntu)
Once Bystro annotator installation is complete, and assuming Conda/Miniconda has been installed, run :

1. `git clone https://github.com/akotlar/bystro.git && cd bystro && source ./install-apt.sh`
```sh
# Install Rust
curl https://sh.rustup.rs -sSf | sh -s -- -y
echo -e "\n### Bystro: Done installing Rust! Now sourcing .cargo/env for use in the current shell ###\n"
source "$HOME/.cargo/env"
# Create or activate Bystro conda environment and install all dependencies
# This assumes you are in the bystro folder
source .initialize_conda_env.sh;
```

to install the Python package dependencies. Then, run:
```
# Build the Python package for local use
make build
```

## Example of installation on RPM-based Amazon AMI (any 'yum'-capable Amazon AMI)
to intall the Bystro Python library.

Run the script found @ https://github.com/akotlar/bystro-aws
Follow the instructions below to install the Bystro annotator:

## Configuring Bystro for annotation
## Configuring the Bystro annotator

Once Bystro is installed, it needs to be configured. The easiest step is choosing the species/assemblies to annotate.

Expand Down
3 changes: 1 addition & 2 deletions install/install-apt-deps.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

echo -e "\n\nInstalling Ubuntu/Debian (apt-get) dependencies\n";

sudo apt update;
# Installs gcc, and more; may be too much
sudo apt install -y build-essential;

Expand Down Expand Up @@ -31,4 +30,4 @@ sudo apt install -y nodejs;
sudo apt install -y npm;
sudo npm install -g pm2;

sudo apt install -y awscli;
sudo apt install -y awscli;

0 comments on commit 65f87d8

Please sign in to comment.