Skip to content

Add conda installation instructions and a few reorderings #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tapaswenipathak merged 1 commit into from
May 28, 2022
Merged

Add conda installation instructions and a few reorderings #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion docs/installations/installation-on-gnu-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
Installation on GNU/Linux
=========================

## Install via Conda

Use conda or bioconda to install OpenMS.

1. Follow the instructions to [install conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html).
2. Install OpenMS using conda:
`conda install -c openms openms`
3. Other OpenMS packages can be installed using:
```
conda install -c openms pyopenms
conda install -c openms openms-thirdparty
conda install -c openms libopenms
```

To install using bioconda:

```
conda install -c bioconda openms
conda install -c bioconda/label/cf201901 openms
conda install -c bioconda openms-tools
conda install -c bioconda libopenms
conda install -c bioconda openms-thirdparty
```

## Install via Debian Package

For Debian-based Linux users, it is suggested to use the [deb-package](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/OpenMSInstaller/release/latest/) provided. It is most easily installed with **[gdebi](https://launchpad.net/gdebi)**
Expand Down Expand Up @@ -49,7 +73,7 @@ Debian package.

```

## Installation via Building From Source Code
## Installation via building from source code

The source code of OpenMS is available on GitHub. Follow [Building OpenMS on GNU/Linux](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/Documentation/nightly/html/install_linux.html) instructions on how to build OpenMS from source.

Expand Down
6 changes: 6 additions & 0 deletions docs/installations/installation-on-macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Installation on macOS
====================

## Install via macOS installer

To install OpenMS on macOS, run the following steps:

1. Download and install the macOS drag-and-drop installer from the [archive](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/OpenMSInstaller/release/latest/).
Expand Down Expand Up @@ -35,6 +37,10 @@ source ${OPENMS_TOPP_PATH}/.TOPP_bash_profile

Make sure `<OpenMS-PATH>` points to the folder where OpenMS is installed locally (e.g., `/Applications/OpenMS-<version>`)

## Install via Conda or Bioconda

Follow [these](installation-on-gnu-linux.md#install-via-conda) instructions.

## Known Issues

1. OpenMS software landing in quarantine since macOS Catalina after installation of the `.dmg`.
Expand Down
4 changes: 3 additions & 1 deletion docs/installations/installation-on-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Installation on Windows
=======================

## Install via Windows Installer

To Install the binary package of OpenMS & TOPP:

1. Download and execute the installer `OpenMS-<version>-Win64.exe` from the [archive](https://abibuilder.informatik.uni-tuebingen.de/archive/openms/OpenMSInstaller/release/latest/) and follow its instructions.
Expand All @@ -12,7 +14,7 @@ The windows binary version works with most versions of windows from Win7 to Win1
still work but are untested).
```

## Known Issues
## Known Issues

1. During installation, an error message pops up, saying "The installation of the Microsoft .NET 3.5 SP1' package failed!

Expand Down