Mercurial > repos > galaxyp > openms_idposteriorerrorprobability

annotate test-data/examples/external_code/README.md @ 18:6daaa75ccb99 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
author galaxyp
date Sun, 13 Dec 2020 15:03:50 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
1 # Example CMake project using OpenMS
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
2
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
3 Example project for external code using OpenMS library and headers.
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
4 You can modify the build system via CMakeLists.txt, e.g., to add more C++ classes, alter build flags, or add additional dependencies.
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
5
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
6 ## Usage
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
7
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
8 Assuming everything happens in the directory `~/Development`, e.g., the OpenMS sources are located in `~/OpenMS` and OpenMS was compiled in `~/OpenMS-build`. For any details on how to compile OpenMS please check out either the documentation shipped with OpenMS or online at http://www.openms.de/documentation.
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
9
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
10 1. Compile OpenMS (e.g., in `~/Development/OpenMS-build`)
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
11 2. Create a new build directory for this example project (e.g., `mkdir ~/Development/example-build`)
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
12 3. Call CMake from the new directory and add the path to this directory (e.g., `cmake -G "<generator used for OpenMS>" ~/Development/OpenMS/share/OpenMS/examples/external_code/`).
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
13
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
14 **Note**: In general you should try to use the same setup (compiler etc.) for OpenMS and your project. Especially on Windows you need to use the same CMake Generator for OpenMS and the new project.
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
15
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
16 Should the above step fail because CMake couldn't find OpenMS you can specify the OpenMS instance when calling CMake, e.g.,
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
17
6daaa75ccb99 "planemo upload for repository https://github.com/galaxyproteomics/tools-galaxyp/tree/master/tools/openms commit 6e7368b7f178fbd1f08c28eea1b538add6943a65-dirty"
galaxyp
parents:
diff changeset
18 ```cmake -G "<generator used for OpenMS>" -D OpenMS_DIR=~/Development/OpenMS-build/ ~/Development/OpenMS/share/OpenMS/examples/external_code/```