Welcome to CoFI’s documentation!#

CoFI (Common Framework for Inference) is an open-source initiative for interfacing between generic inference algorithms and specific geoscience problems.

This project is led by InLab.

graph TD; cofi(CoFI - Common Framework for Inference):::cls_cofi; parameter_estimation(Parameter estimation):::cls_parameter_estimation; linear(Matrix based solvers):::cls_parameter_estimation; non_linear(Optimization):::cls_parameter_estimation; linear_system_solvers(Linear system solvers):::cls_parameter_estimation; linear_solverlist(scipy.linalg.lstsq <br> PETSc <br>...):::cls_solvers; optimization(Non linear):::cls_parameter_estimation; optimization2(Linear):::cls_parameter_estimation; opt_solverlist(scipy.optimize.minimize <br> torch.optim <br> PETSc <br>...):::cls_solvers; ensemble_methods(Ensemble methods):::cls_ensemble_methods; direct_search(Direct Search):::cls_ensemble_methods; amc(Monte Carlo):::cls_ensemble_methods; amc_solverlist(Neighbourhood Algorithm <br> Bayesian Optimization <br> Slime mold algorithm<br>...):::cls_solvers; ng(Deterministic):::cls_ensemble_methods; ng_solverlist(Nested grids <br> Hilbert Curves<br>...):::cls_solvers; bs(Bayesian Sampling):::cls_ensemble_methods; mcmc(McMC samplers):::cls_ensemble_methods; mcmc_solverlist(Basic metropolis<br>Affine Invariance sampler<br>emcee <br> pyMC <br> ...):::cls_solvers; rjmcmc(Trans-D McMC):::cls_ensemble_methods; rjmcmc_solverlist(Basic Trans-D <br> RJ-mcmc):::cls_solvers; cofi --> parameter_estimation; parameter_estimation --> linear; linear --> linear_system_solvers; linear_system_solvers -.- linear_solverlist; parameter_estimation --> non_linear; non_linear --> optimization; non_linear --> optimization2; optimization -.- opt_solverlist; optimization2 -.- opt_solverlist; cofi --> ensemble_methods; ensemble_methods --> direct_search; direct_search --> amc; amc -.- amc_solverlist; direct_search --> ng; ng -.- ng_solverlist; ensemble_methods --> bs; bs --> mcmc; mcmc -.- mcmc_solverlist; bs --> rjmcmc; rjmcmc -.- rjmcmc_solverlist; classDef cls_cofi fill: #d4a373, stroke-width:0; classDef cls_parameter_estimation fill: #ccd5ae, stroke-width:0; classDef cls_ensemble_methods fill: #e9edc9, stroke-width:0; classDef cls_solvers fill: #faedcd, stroke-width:0;

Installation

🐣 New to CoFI?

Start here

Reference documentation

📑 A list of our functions and classes

API reference

Need support?

❓ Ask in our Slack workspace

Join the conversation

Contribute to CoFI

🛠 Any forms of contribution are welcomed

Developer notes

Table of contents#