Skip to content

MAPIRlab/gaden_core

Repository files navigation

Gaden core library

Gaden is a gas dispersion simulator! This repo contains the backend core library, which can just use directly in your C++ or Python project, or accessed through the ROS and GUI frontends.

See the tutorial for basic info on the data types that this library defines and how to use them.

Installation and building

If you plan to use one of the frontends, don't download this repo separately. Instead, follow the instructions in the corresponding repo.

If you are going to use the library directly, clone the repo with

git clone --recursive git@github.com:MAPIRlab/gaden_core.git

You can then build the project as follows:

mkdir build
cd build 
cmake ..
make 

Usage in a CMake project

You can use gaden in a C++ project with CMake as follows:

add_subdirectory([path]/gaden_core)
add_executable([your_exec])
target_link_libraries([your_exec] gaden)

Python bindings

You can generate Python bindings for the gaden core library with cppyy. To generate them, simply enable the corresponding option in the CMakeLists.txt before building.

Creating these bindings requires the following dependencies:

pip install wheel
pip install cppyy
pip install libclang==13
sudo apt install libclang-13-dev

Usage example

See this folder.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages