This release is a pre-release and may not be stable for production use.
CoFI (Common Framework for Inference)
Introduction
CoFI (Common Framework for Inference) is an open-source initiative for interfacing between generic inference algorithms and specific geoscience problems.
With a mission to bridge the gap between the domain expertise and the inference expertise, CoFI provides an interface across a wide range of inference algorithms from different sources, underpinned by a rich set of domain relevant examples.
This project and documentation are under initial development stage. Please feel free to contact us for feedback or issues!
Installation
$ pip install cofi
Check CoFI documentation - installation page for details on dependencies and setting up with virtual environments.
Basic Usage
CoFI API has flexible ways of defining an inversion problem. For instance:
from cofi import BaseProblem
inv_problem = BaseProblem()
inv_problem.set_objective(my_objective_func)
inv_problem.set_initial_model(my_starting_point)
Once a problem is defined, cofi can tell you what inference solvers you can use based on what level of
information you've provided:
inv_problem.suggest_solvers() # a tree will be printed
Run an inversion with these lines:
from cofi import InversionOptions, Inversion
inv_options = InversionOptions()
inv_options.set_solving_method("optimisation")
inv_options.set_params(options={"maxiter":100})
inv = Inversion(inv_problem, inv_options)
result = inv.run()
print(result.success)
print(result.model)
And now an inversion is completed! Check out our example gallery and tutorial pages for more real-world or advanced use cases.
Contributing
Interested in contributing? Please check out our contributor's guide.
Licence
This project is distributed under a 2-clause BSD licence. A copy of this licence is provided with distributions of the software.
4 maintainers
Metadata
4 maintainers
Release files for cofi 0.1.2.dev9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cofi-0.1.2.dev9.tar.gz | 1.3 MB | Details |
Release files / cofi-0.1.2.dev9.tar.gz
| Download URL | cofi-0.1.2.dev9.tar.gz |
|---|---|
| Size | 1.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea60130ba1cb631dcea87df3a7536174b1ad694f4299322599351840036a2ff1
|
|
BLAKE2b-256 checksum How to use checksums |
7498fcc9a31df3c5d8683ebd7254bce8e67290e8deb598c3ca69ab77d2a84447
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.14
|
