What it computes

YSpec solves the radial equations of motion and sums the resulting spectra into displacement, velocity or acceleration traces. Models may be transversely isotropic and anelastic, with an ocean or no ocean and either a solid or fluid inner core. Gravity can be omitted, treated with the Cowling approximation or included fully.

The project is a C++23 reimplementation of YSpec by David Al-Attar, following Friederich and Dalkolmo (1995) and Al-Attar and Woodhouse (2008). It retains the name YSpecpp as the repository name; the C++ namespace and library are YSpec, and the command-line programs are yspec and yspec-snapshot. See the repository's BSD 3-Clause license.

Choose a route

For a complete small calculation, start with the first seismogram. To compile a source-tree application that calls the C++ API, follow the library example. The installation guide covers prerequisites and build options.

The generated API reference is built from the same public headers and README as the checked source revision. It complements the task guides rather than replacing them.

Units and output frames

Input JSON names kilometres, millihertz and minutes explicitly where used. The high-level C++ calculation API uses SI units, including metres and hertz; geographic angles are degrees. Earth-model material properties and the low-level radial solver use nondimensional quantities.

Seismograms report up, north and east components. Snapshot fields use up, away and transverse components, where away follows the great circle from the source and transverse is 90 degrees anticlockwise from away when viewed from above.

Limits to keep in view

The solver tolerance controls local integration steps; it is not a universal error bound on every trace. Check degree, frequency band, record duration and tolerance for the calculation of interest. Strain and radial kernels are C++ library functionality; the two command-line programs accept seismogram and snapshot inputs.

YSpec's install rules add the two programs; dependency projects may install their own files. The source build also provides a C++ library target, but no installed find_package(YSpec) package is exported.