Comments (3)
Hey!
If I only need the IO module (biocpp-io), I still need to have biocpp-core as well, right?
Yes, the core library is required by the io-library. This should be documented in the README (https://github.com/biocpp/biocpp-io/blob/main/README.md#dependencies)! The IO-library hasn't had a release, yet, so it's not in the doxygen, but I hope to get a release done in the next week or two.
Do both of them need to be added as submodules separately?
Yes, they are separate repositories.
It gives a weird directory structure as a result (project/submodule/biocpp-io/include/biocpp/io/ and project/submodule/biocpp-core/include/biocpp/alphabet etc/).
You can have them "beside" each other in your project, they don't need to be nested within each other!
If biocpp-core is a requirement of biocpp-io, why not just have them in the same project?
The core-library is aiming for a stable release fairly soon and will then receive mostly bug-fixes and small improvements; it will follow a more conservative approach (no API breaks, more stringent code-reviews...).
The IO-library, on the other hand, will have a more lively development. And more libraries are planned that would make use of core but not IO. That's why they are separate.
I realized while following the core-setup, I need the fmt library. I added it as another submodule and then added it into my CMakeLists.txt file, but this wasn't explicitly mentioned anywhere. Is it a necessary submodule?
It's not required, but it is recommended. The core-setup tutorial is unfortunately not fully up-to-date :( But it is mentioned in the README: https://github.com/biocpp/biocpp-core#easy-to-use
Here is an example of a project of mine that uses the libraries:
https://github.com/h-2/decovar/
This is all you need in the CMake for biocpp-core, biocpp-io, sharg-parser and fmt:
find_package (biocpp REQUIRED COMPONENTS core io
HINTS "${CMAKE_SOURCE_DIR}/submodules/biocpp-core/build_system")
find_package (sharg REQUIRED
HINTS "${CMAKE_SOURCE_DIR}/submodules/sharg-parser/build_system")
set(FMT_DOC OFF)
set(FMT_INSTALL OFF)
set(FMT_TEST OFF)
add_subdirectory(submodules/fmt)
For BioC++, it is enough to add the core-library's CMake-stuff and tell it the COMPONENTS you want. As long as the other components (in this case io
) are either "beside" the core-library (biocpp-io is in same folder as biocpp-core) or within biocpp-core/submodules it should "just work". Actually, it should also work, if biocpp-core is in biocpp-io/submodules/, but then you have to do find_package(biocpp_io)
and not find_package(biocpp COMPONENTS io)
...
from biocpp-core.
P.S: You are very invited to submit a PR for core-setup tutorial 😇
from biocpp-core.
Instead of having the modules include each other as submodules, the plan is to have a biocpp/biocpp meta repository that includes the other ones and also fmt. Then, you can just clone from that and get everything. But I haven't set it up, yet.
from biocpp-core.
Related Issues (1)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from biocpp-core.