Skip to content

Commit 2157a0d

Browse files
Improve installation instructions for OpenMS
1 parent 4b21655 commit 2157a0d

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

docs/installation.md

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

Comments
 (0)