tectonics.cpp is a header-only C++ library that's intended to supplant the backend to tectonics.js. It contains only the best parts of tectonics.js - the parts that either have proven out over time or have emerged with confidence as replacements through good design.
This library is not just designed for use by tectonics.js. Numerous space simulators can make use of the functionality here. The components here are lightweight and loosely coupled. Parts of the library can be easily taken out, mixed and matched, and modified. The library is also rigorously covered by unit tests. It's a shame really if this library only gets used once.
Permission to use the code is provided under the Creative Commons Attribution 4.0 license. You may modify and redistribute the code as you see fit. You need only attribute the work to me as the project developer, which I appreciate since it helps me develop professionally. Drop me a line if you do so since it's encouraging to hear my work is getting used!
Make file commands exist throuhgout the library for building demos and running unit tests. Simply run make in any project folder with a Makefile to run all the functionality that's defined within that folder.
Building with scons is also supported. Simply run scons -u from any project folder to run the functionality that's defined within that folder.
Running the graphics demo requires two other libraries to be installed on your machine: GLEW and GLFW. On Ubuntu you can install both with the following commands:
sudo apt-get install libglew-dev sudo apt-get install libglfw3-dev
tectonics.cpp is adheres to a strict design philosophy that is meant to prioritize functional programming concerns in a way that also leverages object-oriented paradigms. See doc/general-design-approach.md for more information.
tectonics.cpp can be broken down into several subcomponents. Users can pick and choose which subcomponents they'd like to include in their project at their discretion. Some optional dependencies exist between subcomponents, which are indicated clearly by the folder structure (e.g. index/adapted/glm stores behavior that requires glm). Using optional dependencies this way allows the use of functionality that wouldn't otherwise be possible without requiring people to copy over other unwanted components.
The most important top-level folders are:
libfor header-only 3rd party librariesincfor mature components that are ready for use by other code, such as formath,grids, or scientificunits andmodelssketchfor long-running prototypes and outlines that cannot be suitably handled by software branchessrcfor code that is not expected to be useful to projects outside tectonics, such as the code for handling the UI that's used withindemodemofor code that requires 3d libraries to run, usually to demonstrate functionality in the librarydocfor project-wide documentation that cannot be suitably put alongside any specific folder or file in the repository
Unit tests and documentation are placed alongside the folder or file they describe. File-specific documentation is stored in image or markdown files that share the same name as the thing it documents (e.g. grid/dymaxion/Projection.svg documents grid/dymaxion/Projection.hpp). Folder-specific documentation is stored in the folder it documents using one of several standardized names, in uppercase (e.g. README.md, CATEGORY.png, DEPENDENCY.png, etc.)
- Semantic Versioning 2.0.0
- "GLSL/GLM" Linear Algebra API
- "MKS/SI" International System of Units