Skip to content

Quickstart

Optionally define a Conda virtual environment from the included environment.yml indicating dependencies for demos and development.

virtual environment
conda env create -f environment.yml
conda activate ennui_dev

C++ Unit tests

While building without conan is possible, the following simplified processes requires conan.

To build with conan

building with conan
conan build .
Unit tests are run by calling the output. For windows systems
run tests - Windows
.\build\bin\Release\ennui_test.exe
For unix systems
run tests - Unix
./build/Release/bin/ennui_test

Python

Install the python package pyennui locally using pip

install python package
pip install .
From python, evaluate the gravitation vector at the White House.

python demo
1
2
3
4
5
6
7
8
import numpy as np
from pyennui.geodetic import gravitation_ecef

WhiteHouse_ECEF = np.array(
    (1.1150423452941689e06, -4.8438122981491517e06, 3.9835202164462707e06)
)

gravitation_ecef(WhiteHouse_ECEF)

MATLAB

MATLAB bindings are built specifying the appropriate option

build MATLAB bindings
conan build . -o with_matlab=True
Similarly, the python binding can be built
build python bindings
conan build . -o with_python=True
Note, MATLAB and python use conflicting matrix layouts. Deleting the build folder is recommended when switching between build generators.

Demos

Check out demos of python bindings and matlab bindings