- CMake - C++ Build Tool
- Poetry - Python Package Manager
- Doxygen - Documentation Generator
- Sphinx - Documentation Generator
Mac OS: brew install cmake
Linux: apt-get install cmake
pip install poetry
Mac OS: brew install doxygen
Linux: apt-get install doxygen
Mac OS:
brew install sphinx-build
then add the following to your .zshrc or .bashrc file:
export PATH="/usr/local/opt/sphinx-doc/bin:$PATH"
Linux: https://www.sphinx-doc.org/en/master/usage/installation.html
Squiggles is built with CMake. A convenience script for creating the
CMake makefiles on a *nix environment is included as run_cmake_format.sh.
After creating the CMake makefiles, you can run make from the build directory to build the library.
The tests are built alongside the source binaries and depend on GoogleTest. GoogleTest is pulled automatically by CMake.
The path visualizations are created with Python and Matplotlib. The dependencies for the Python portion of the project are handled by Poetry.
To install the Python dependencies, run poetry install.
If you have not built the Core Library yet, do that first.
Open a Poetry shell with poetry shell.
Then run poetry run vis to run the visualization.
The documentation is built with Sphinx and Doxygen and is generated in the docs directory.
To install the Python dependencies, run poetry install from the root of the repo.
Open a Poetry shell with poetry shell.
Then, from the docs directory, run make html.