Get started
Verified first-run path: Ubuntu 24.04 with GCC 13, CMake 3.24 or later, and FFTW3 development libraries. The project also requires a C++23 compiler.
{{REVISION_NOTICE}}
YSpecpp requires a C++23 compiler and FFTW3 libraries in single, double and long-double precision. OpenMP is enabled by default; set YSPEC_WITH_OPENMP=OFF for a serial build. CMake fetches the other pinned C++ dependencies on a cold configure, so that first configuration needs network access. The documented path below uses GCC 13 and a maximum of two build jobs.
sudo apt update
sudo apt install build-essential cmake git g++-13 libfftw3-devDoxygen 1.9.8 is needed for the API reference; on Ubuntu 24.04 install it with sudo apt install doxygen. The plotting package is optional for calculations and the documentation build; install it separately to reproduce the illustrated trace: sudo apt install python3-matplotlib. The repository declares CMake 3.24 as the minimum for manual configuration. Its presets use schema version 6 and therefore require CMake 3.25 or newer.
Clone the source at the revision identified by the manual's revision notice. That notice states the source revision and whether the manual has uncommitted changes. Build the command-line programs without fetching GoogleTest:
git clone https://github.com/da380/YSpecpp.git
cd YSpecpp
git checkout {{BASE_REVISION}}
cmake -S . -B build/guide -DCMAKE_CXX_COMPILER=g++-13 \
-DCMAKE_BUILD_TYPE=Release -DYSPEC_BUILD_TESTS=OFF
cmake --build build/guide --target yspec yspec-snapshot --parallel 2Install the two programs to a local prefix:
cmake --install build/guide --prefix "$PWD/build/guide/install"The executables are then at build/guide/install/bin/yspec and build/guide/install/bin/yspec-snapshot. The YSpec install rules do not install an exported C++ library package.
By default, CMake fetches the revisions pinned in the project's top-level CMake file. To substitute a local checkout for one dependency, pass its matching FETCHCONTENT_SOURCE_DIR cache variable at configure time. For example:
cmake -S . -B build/guide -DCMAKE_CXX_COMPILER=g++-13 \
-DCMAKE_BUILD_TYPE=Release -DYSPEC_BUILD_TESTS=OFF \
-DFETCHCONTENT_SOURCE_DIR_NUMERICCONCEPTS=/path/to/NumericConcepts \
-DFETCHCONTENT_SOURCE_DIR_INTERPOLATION=/path/to/InterpolationEach override should point to the revision expected by the source tree. The local preset shows the complete variable names. Overrides select local sources; they do not change the revisions recorded in the project.
The existing examples/library.cpp program is compiled as the library_example target when tests are enabled. Configure with -DYSPEC_BUILD_TESTS=ON, build that target, then run it from the build tree. The checked commands and expected result are in the C++ library guide. No installed CMake package is provided.
The manual tooling needs only Python's standard library and Doxygen 1.9.8. It does not configure the numerical project or fetch its dependencies:
python3 docs/tools/build_docs.py --output build/guide-docs
python3 docs/tools/check_docs.py build/guide-docs/siteThe build creates a revision notice, copies the standalone guide assets and invokes the existing strict Doxygen template directly. Generated pages and warnings are written under the ignored build directory.