Developer Installation Instructions

Overview

This document provides detailed instructions for developers to build OpenMS from source.

Before you begin, ensure you have the following prerequisites installed:

CMake: Version 3.10 or higher. You can download it from CMake's official website.
Boost Libraries: Ensure you have the latest version. Installation instructions can be found on the Boost website.
Qt: Version 5.9 or higher. Download it from the Qt website.
Python: Version 3.6 or higher. You can download it from Python's official website.

Follow these steps to build OpenMS from source:

Clone the Repository: Open a terminal and run the following commands to clone the OpenMS repository:
```
git clone https://github.com/OpenMS/OpenMS.git
cd OpenMS
```
Create a Build Directory: Create a separate directory for building the project to keep the source directory clean:
```
mkdir build
cd build
```
Configure the Build: Use CMake to configure the build. This step checks for all necessary dependencies:
```
cmake ..
```
Compile the Project: Compile the project using the make command. This process may take some time depending on your system:
```
make
```
Run Tests (optional): It's recommended to run tests to ensure everything is working correctly:
```
make test
```
Install OpenMS: Finally, install OpenMS on your system. You may need superuser privileges for this step:
```
sudo make install
```

Dependency Issues: If you encounter issues with dependencies, ensure all prerequisites are correctly installed and accessible in your PATH. You can verify this by running cmake .. and checking for any error messages.
Build Errors: For detailed error messages, check the build logs located in the build directory. This can help diagnose issues related to missing files or incorrect configurations.
Further Assistance: If you continue to experience issues, consider reaching out to the OpenMS community via their GitHub Issues page for support.