Editing CoFI core

Editing CoFI core#

Here we provide a mapping table to the parts of code related to each existing feature.

Table: feature mapping to code file#

Functionality

Code file path

BaseProblem

src/cofi/base_problem.py

InversionOptions

src/cofi/inversion_options.py

Inversion

src/cofi/inversion.py

InversionResult

src/cofi/inversion.py

inference tools tree

src/cofi/tools/__init__.py

inference tool dispatch function

src/cofi/inversion.py

BaseInferenceTool

src/cofi/tools/base_inference_tool.py

validation for BaseProblem and InversionOptions objects

src/cofi/tools/base_inference_tool.py

Checklist on adding a new set method in BaseProblem

Except for tests, all changes should take place in src/cofi/base_problem.py.

  1. add method set_something(self, something)

  2. add property/method something(self)

  3. add method something_defined(self) -> bool

  4. add something to list BaseProblem.all_components

  5. write tests in tests/test_base_problem.py (“test_non_set”, etc.)