Scientific code for solving fiber modal / spectral scanning problems.
Quick overview
- Language: C++ (with Armadillo, MPI, SLEPc/PETSc integration)
- License: MIT (see
LICENSE)
Quick build
- Install dependencies: MPI implementation (OpenMPI/MPICH), PETSc/SLEPc, and Armadillo.
- From the repo root run
make(thesrc/Makefileincludes architecture-specific files insys/).
Example run
- See
simulations/runtestfor a small example input and prebuilt binary.
Repository layout
src/: sources andMakefileused to build the executable (spectral_scan.exec).- Note:
src/classes.lstcontains theOBJSlist used by theMakefile. Add new object files there when adding sources.
- Note:
include/: public headers describing major classes (fiber,communicator,params, etc.).simulations/: example cases and input files.docs/: additional documentation (this folder).
Where to look next
docs/usage.md— how to run simulations and example commands.docs/development.md— build flags, adding new modules, and coding conventions.docs/api.md— short reference for public headers ininclude/.