Skip to content

Commit 0a3ad66

Browse files
authored
Update build_from_source.rst
1 parent 7a092ec commit 0a3ad66

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/source/community/build_from_source.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,33 @@ Depending on your systems setup, it may make sense to do this inside a virtual e
3535
virtualenv pyopenms_venv
3636
source pyopenms_venv/bin/activate
3737
38-
Next, configure OpenMS with pyOpenMS as target.
38+
Next, we will configure the CMake-based OpenMS build system
39+
to enable the pyOpenMS target with the configuration option ``-DPYOPENMS=ON``.
3940
If your are using virtualenv or a specific Python version,
4041
add ``-DPYTHON_EXECUTABLE:FILEPATH=/path/to/python`` to ensure
4142
that the correct Python executable is used. Compiling pyOpenMS can use a lot of
4243
memory and take some time, however you can reduce the memory consumption by
4344
breaking up the compilation into multiple units and compiling in parallel, for
4445
example ``-DPY_NUM_THREADS=2 -DPY_NUM_MODULES=4`` will build 4 modules with 2
45-
threads. You can then configure pyOpenMS:
46+
threads. You can now configure pyOpenMS (inside your build folder) with:
4647

4748
.. code-block:: bash
4849
49-
cmake --build YOURBUILDFOLDER --target pyopenms --config Release
50+
cmake -DPYOPENMS=ON
51+
52+
53+
Remember, that you can pass the other options as described above to the first
54+
command by adding ``-DOPTION=VALUE`` statements if you need them.
55+
56+
Now build pyOpenMS (now there should be pyOpenMS specific build targets).
57+
If you are still inside your build folder, you can use "." as the build
58+
folder parameter.
59+
60+
.. code-block:: bash
61+
62+
cmake --build $YOURBUILDFOLDER --target pyopenms --config Release
63+
5064
51-
Build pyOpenMS (now there should be pyOpenMS specific build targets).
5265
Afterwards, test that all went well by running the tests:
5366

5467
.. code-block:: bash

0 commit comments

Comments
 (0)