Skip to content

Commit

Permalink
ENH Better information for installation (#66)
Browse files Browse the repository at this point in the history
* ENH fix pyrodigal version avoid error

Newer versions of pyrodigal uses different command names for the old functions in the script, keeping the results. So, we fix the version to avoid breaking the code with different python versions.

* ENH Include specification for dedicated environment

Include instructions for installation of macrel inside a dedicated environment as the preferred method to work with Macrel. That is important to avoid conflict of common packages that most of the programs use in different versions that may conflict inside the Macrel's structure.

* ENH installation instructions clarity

make the recipe for installation using conda in a dedicated environment more clear. ---
  • Loading branch information
celiosantosjr committed Oct 30, 2023
1 parent a4e24de commit 59e3532
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ Macrel as a whole is under the **MIT** license.
The recommended method of installation is through
[bioconda](https://anaconda.org/bioconda/macrel):

```bash
conda create --name env_macrel -c bioconda macrel
conda activate env_macrel
macrel -h
```

Alternatively, just:

```bash
conda install -c bioconda macrel
```
Expand Down
2 changes: 1 addition & 1 deletion install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ fi
${CONDA_INSTALL_CMD} install -y \
--prefix $BASEDIR/envs/Macrel_env \
ngless \
"pyrodigal>=0.7.3" \
"pyrodigal<3.0.0" \
megahit \
paladin \
pandas \
Expand Down

0 comments on commit 59e3532

Please sign in to comment.