This example demonstrates how to use Cyantities to connect Python quantities with a C++ numerics backend that uses Boost Units.
This example is a simple, self-contained script (run.py). For this reason, the C++ code is built and copied to this current directory, allowing the execution of run.py as a one-shot simulation.
To build the code, simply run
python build.pyin this directory (with prerequisites numpy, cyantities, meson, ? installed).
To run the simulation after building,
python run.py
This simulates a ball comparable to a baseball being thrown at professional
speeds in a 45° angle with air friction, and writes the resulting trajectory
to a result.pdf file (requires matplotlib).
The purpose of this example is to demonstrate how to build a C++ numerics code interfaced by Cyantities.
There are three source files for the binary extension: parasolve.pyx,
parasolve.hpp, and parasolve.cpp. These reflect the typical minimum of
source files (more C++ sources would probably exist). The meson.build file
illustrates how these sources can be compiled into a Python extension.
The build.py script is a simple build script that uses Meson to compile
the parasolve extension, and subsequently copies the built extension to
this root folder. Since this example aims to mimic a specialized scientific
simulation, that is typically executed for one purpose only, the whole
layout is kept simple and based on everything being available in this
root directory and controlled by the run.py control script.
The subprojects/cyantities/meson.build blueprint Meson build file takes care of the discovery of the Cyantities headers and provides a Meson requirement. It can simply be copied to Meson-based projects to include and link to Cyantities.