Skip to content

API reference

The reference for numgeo-ACT's public interface. It is split into two pages, depending on what you are doing:

User API

The functions you call to run a calibration include reading the Excel database, choosing and configuring a model, describing the problem with globals.setup, and launching DEEM, CMA-ES, SMAC-style or local optimisation. Start here if you want to calibrate a model.
User API

Developer API

The internals cover the package layout, the constitutive-model interface and the similarity, weighting, plotting, reporting and runtime modules. Start here if you want to extend numgeo-ACT (e.g. add a model, a similarity measure, or an optimizer back-end).
Developer API

For step-by-step narrative rather than a reference, see the calibration workflow and the Quickstart. The standalone DEEM algorithm has its own documentation and API reference.