|
| 1 | +# Developer Installation Instructions |
| 2 | + |
| 3 | +## Overview |
| 4 | + |
| 5 | +This document provides detailed instructions for developers to build OpenMS from source. |
| 6 | + |
| 7 | +## Prerequisites |
| 8 | + |
| 9 | +Before you begin, ensure you have the following prerequisites installed: |
| 10 | + |
| 11 | +- **CMake**: Version 3.10 or higher. You can download it from [CMake's official website](https://cmake.org/download/). |
| 12 | +- **Boost Libraries**: Ensure you have the latest version. Installation instructions can be found on the [Boost website](https://www.boost.org/). |
| 13 | +- **Qt**: Version 5.9 or higher. Download it from the [Qt website](https://www.qt.io/download). |
| 14 | +- **Python**: Version 3.6 or higher. You can download it from [Python's official website](https://www.python.org/downloads/). |
| 15 | + |
| 16 | +## Building from Source |
| 17 | + |
| 18 | +Follow these steps to build OpenMS from source: |
| 19 | + |
| 20 | +1. **Clone the Repository**: |
| 21 | + Open a terminal and run the following commands to clone the OpenMS repository: |
| 22 | + ```bash |
| 23 | + git clone https://github.com/OpenMS/OpenMS.git |
| 24 | + cd OpenMS |
| 25 | + ``` |
| 26 | + |
| 27 | +2. **Create a Build Directory**: |
| 28 | + Create a separate directory for building the project to keep the source directory clean: |
| 29 | + ```bash |
| 30 | + mkdir build |
| 31 | + cd build |
| 32 | + ``` |
| 33 | + |
| 34 | +3. **Configure the Build**: |
| 35 | + Use CMake to configure the build. This step checks for all necessary dependencies: |
| 36 | + ```bash |
| 37 | + cmake .. |
| 38 | + ``` |
| 39 | + |
| 40 | +4. **Compile the Project**: |
| 41 | + Compile the project using the `make` command. This process may take some time depending on your system: |
| 42 | + ```bash |
| 43 | + make |
| 44 | + ``` |
| 45 | + |
| 46 | +5. **Run Tests** (optional): |
| 47 | + It's recommended to run tests to ensure everything is working correctly: |
| 48 | + ```bash |
| 49 | + make test |
| 50 | + ``` |
| 51 | + |
| 52 | +6. **Install OpenMS**: |
| 53 | + Finally, install OpenMS on your system. You may need superuser privileges for this step: |
| 54 | + ```bash |
| 55 | + sudo make install |
| 56 | + ``` |
| 57 | + |
| 58 | +## Troubleshooting |
| 59 | + |
| 60 | +- **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. |
| 61 | +- **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. |
| 62 | +- **Further Assistance**: If you continue to experience issues, consider reaching out to the OpenMS community via their [GitHub Issues page](https://github.com/OpenMS/OpenMS/issues) for support. |
0 commit comments