Skip to content

Commit

Permalink
update conda docs and macOS install
Browse files Browse the repository at this point in the history
  • Loading branch information
gbouras13 committed Nov 22, 2024
1 parent 777e6fb commit 2d91957
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 28 deletions.
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ If you don't want to install `pharokka` or `phold` locally, you can run `pharokk
- [Source](#source)
- [Database Installation](#database-installation)
- [Beginner Conda Installation](#beginner-conda-installation)
- [Beginner Conda Installation](#beginner-conda-installation-1)
- [Usage](#usage)
- [Version Log](#version-log)
- [System](#system)
Expand Down Expand Up @@ -294,35 +295,49 @@ which will create a directory called "pharokka_v1.4.0_databases" containing the

If you are new to using the command-line, please install conda using the following instructions.

1. Install [Anaconda](https://www.anaconda.com/products/distribution). I would recommend [miniconda](https://docs.conda.io/en/latest/miniconda.html).
2. Assuming you are using a Linux x86_64 machine (for other architectures, please replace the URL with the appropriate one on the [miniconda](https://docs.conda.io/en/latest/miniconda.html) website).

`curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh`
# Beginner Conda Installation

If you are new to using the command-line, please install conda using the following instructions.

1. Install Conda - I would recommend [miniforge](https://github.com/conda-forge/miniforge).
2. Assuming you are using a Linux x86_64 machine (for other architectures, please replace the URL with the appropriate one on the [miniforge](https://github.com/conda-forge/miniforge) repository).

`wget https://github.com/conda-forge/miniforge/releases/download/24.9.2-0/Miniforge3-24.9.2-0-Linux-x86_64.sh`

For Mac Intel:

`wget https://github.com/conda-forge/miniforge/releases/download/24.9.2-0/Miniforge3-24.9.2-0-MacOSX-x86_64.sh`

For Mac (Intel, will also work with M1):
For Mac M1/M2/M3/M4

`curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh`
`wget https://github.com/conda-forge/miniforge/releases/download/24.9.2-0/Miniforge3-24.9.2-0-MacOSX-arm64.sh`

3. Install miniconda and follow the prompts.
3. Install miniforge and follow the prompts.

`sh Miniconda3-latest-Linux-x86_64.sh`
`sh Miniforge3-24.9.2-0-Linux-x86_64.sh`

4. After installation is complete, you should add the following channels to your conda configuration:

```
```bash
conda config --add channels defaults
conda config --add channels bioconda
conda config --add channels conda-forge
```

5. After this, conda should be installed (you may need to restart your terminal). It is recommended that mamba is also installed, as it will solve the enviroment quicker than conda:
5. Finally, I would recommend installing pharokka into a fresh environment. For example to create an environment called pharokkaENV with pharokka installed:

`conda install mamba`
```bash
conda create -n pharokkaENV pharokka
conda activate pharokkaENV
install_databases.py -h
pharokka.py -h
```

6. Finally, I would recommend installing `pharokka` into a fresh environment. For example to create an environment called pharokkaENV with `pharokka` installed:
If you have a Mac with Apple Silicon (M1-M4), try

```
mamba create -n pharokkaENV pharokka
```bash
conda create --platform osx-64 -n pharokkaENV pharokka
conda activate pharokkaENV
install_databases.py -h
pharokka.py -h
Expand Down
39 changes: 24 additions & 15 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ conda install -c bioconda pharokka

This will install all the dependencies along with `pharokka`. The dependencies are listed in environment.yml.

If conda is taking a long time to solve the environment, try using mamba:
If you have a MacOS system with M1/M2/M3 Apple Silicon, try this

```bash
conda install mamba
mamba install -c bioconda pharokka
conda create --platform osx-64 --name pharokkaENV -c bioconda pharokka
conda activate pharokkaENV
```

## Pip
Expand Down Expand Up @@ -100,18 +100,22 @@ which will create a directory called "pharokka_v1.4.0_databases" containing the

If you are new to using the command-line, please install conda using the following instructions.

1. Install [Anaconda](https://www.anaconda.com/products/distribution). I would recommend [miniconda](https://docs.conda.io/en/latest/miniconda.html).
2. Assuming you are using a Linux x86_64 machine (for other architectures, please replace the URL with the appropriate one on the [miniconda](https://docs.conda.io/en/latest/miniconda.html) website).
1. Install Conda - I would recommend [miniforge](https://github.com/conda-forge/miniforge).
2. Assuming you are using a Linux x86_64 machine (for other architectures, please replace the URL with the appropriate one on the [miniforge](https://github.com/conda-forge/miniforge) repository).

`wget https://github.com/conda-forge/miniforge/releases/download/24.9.2-0/Miniforge3-24.9.2-0-Linux-x86_64.sh`

For Mac Intel:

`curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh`
`wget https://github.com/conda-forge/miniforge/releases/download/24.9.2-0/Miniforge3-24.9.2-0-MacOSX-x86_64.sh`

For Mac (Intel, will also work with M1):
For Mac M1/M2/M3/M4

`curl -O https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-x86_64.sh`
`wget https://github.com/conda-forge/miniforge/releases/download/24.9.2-0/Miniforge3-24.9.2-0-MacOSX-arm64.sh`

3. Install miniconda and follow the prompts.
3. Install miniforge and follow the prompts.

`sh Miniconda3-latest-Linux-x86_64.sh`
`sh Miniforge3-24.9.2-0-Linux-x86_64.sh`

4. After installation is complete, you should add the following channels to your conda configuration:

Expand All @@ -121,15 +125,20 @@ conda config --add channels bioconda
conda config --add channels conda-forge
```

5. After this, conda should be installed (you may need to restart your terminal). It is recommended that mamba is also installed, as it will solve the enviroment quicker than conda:
5. Finally, I would recommend installing pharokka into a fresh environment. For example to create an environment called pharokkaENV with pharokka installed:

`conda install mamba`
```bash
conda create -n pharokkaENV pharokka
conda activate pharokkaENV
install_databases.py -h
pharokka.py -h
```

6. Finally, I would recommend installing pharokka into a fresh environment. For example to create an environment called pharokkaENV with pharokka installed:
If you have a Mac with Apple Silicon (M1-M4), try

```bash
mamba create -n pharokkaENV pharokka
conda create --platform osx-64 -n pharokkaENV pharokka
conda activate pharokkaENV
install_databases.py -h
pharokka.py -h
```
```

0 comments on commit 2d91957

Please sign in to comment.