#71 Release v0.1.2.dev10; renaming, data misfit & lstsq improvements

- Close #70 
- Close #68 
- Close #56

CHANGELOG.md

@@ -2,11 +2,20 @@
 
 <!--next-version-placeholder-->
 
-## v0.1.2.dev10 (NOT YET RELEASED)
+## v0.1.2.dev10 (03/10/2022)
+
+### CoFI Core
+
+- [#56](https://github.com/inlab-geo/cofi/issues/56) Modify BaseProblem.data_misfit to include data covariance matrix
+- [#70](https://github.com/inlab-geo/cofi/issues/70) Words renaming optimise -> optimize, etc.
 
 ### CoFI Utils
 
-- [#65](https://github.com/inlab-geo/cofi/issues/54) Utility functions using findiff to generate the difference matrices
+- [#54](https://github.com/inlab-geo/cofi/issues/54) Utility functions using findiff to generate the difference matrices
+
+### CoFI Solvers
+
+- [#68](https://github.com/inlab-geo/cofi/issues/#68) Optimise special cases in linear system solver
 
 
 ## v0.1.2.dev9 (13/09/2022)
@@ -19,7 +28,7 @@
   functions pickleable
 - [#53](https://github.com/inlab-geo/cofi/issues/53) Add set_regularisation(reg, reg_matrix, lamda)
 - [#57](https://github.com/inlab-geo/cofi/issues/57) Create our own exception class
-- [#59](https://github.com/inlab-geo/cofi/issues/59) Optimise import cofi by not importing cofi.solvers
+- [#59](https://github.com/inlab-geo/cofi/issues/59) Optimize import cofi by not importing cofi.solvers
 - [#61](https://github.com/inlab-geo/cofi/issues/61) Remove lambda function from BaseProblem to avoid error in multiprocessing
 
 ### CoFI Solvers

README.md

@@ -55,7 +55,7 @@ Run an inversion with these lines:
 from cofi import InversionOptions, Inversion
 
 inv_options = InversionOptions()
-inv_options.set_solving_method("optimisation")
+inv_options.set_solving_method("optimization")
 inv_options.set_params(options={"maxiter":100})
 
 inv = Inversion(inv_problem, inv_options)

docs/index.rst

@@ -30,7 +30,7 @@ This project is led by `InLab <http://www.inlab.edu.au/>`_.
         non_linear(Non linear):::cls_parameter_estimation;
         linear_system_solvers(Linear system solvers):::cls_parameter_estimation;
         linear_solverlist(scipy.linalg.lstsq <br> ...):::cls_solvers;
-        optimisation(Optimisation):::cls_parameter_estimation;
+        optimization(Optimization):::cls_parameter_estimation;
         opt_solverlist(scipy.minimize <br> PETSc <br> Rapid Optimization Library<br>...):::cls_solvers;
         ensemble_methods(Ensemble methods):::cls_ensemble_methods;
         direct_search(Direct Search):::cls_ensemble_methods;
@@ -49,8 +49,8 @@ This project is led by `InLab <http://www.inlab.edu.au/>`_.
         linear --> linear_system_solvers;
         linear_system_solvers -.- linear_solverlist;
         parameter_estimation --> non_linear;
-        non_linear --> optimisation;
-        optimisation -.- opt_solverlist;
+        non_linear --> optimization;
+        optimization -.- opt_solverlist;
 
         cofi --> ensemble_methods;
         ensemble_methods --> direct_search;

docs/introduction.rst

@@ -14,7 +14,7 @@ components: :code:`BaseProblem`, :code:`InversionOptions`, and :code:`Inversion`
 
 - :code:`BaseProblem` defines three things: 1) the forward problem; 2) model parameter 
   space (the unknowns); and 3) options specific to type of inverse problem you are 
-  trying to solve, such as the definition of an objective function for optimisation.
+  trying to solve, such as the definition of an objective function for optimization.
 - :code:`InversionOptions` describes details about how one wants to run the inversion, including the
   inversion approach, backend tool and solver-specific parameters.
 - :code:`Inversion` can be seen as an inversion engine that takes in the above two as information,
@@ -36,7 +36,7 @@ So a common workflow includes 4 steps:
    `Some useful methods <api/generated/cofi.InversionOptions.html>`_ include:
 
 - :code:`set_solving_method()` and :code:`suggest_tools()`. Once you've set a solving method (from "least squares"
-  and "optimisation", more will be supported), you can use :code:`suggest_tools()` to see a list of backend tools
+  and "optimization", more will be supported), you can use :code:`suggest_tools()` to see a list of backend tools
   to choose from.
 
 .. admonition:: Ways to suggest inversion tools

docs/tutorials/index.rst

@@ -19,7 +19,7 @@ Here are step-by-step guides that cover most of the functionalities and use case
     :caption: Basic usage
     :maxdepth: 1
 
-    1_basic_example_optimiser
+    1_basic_example_optimizer
     2_basic_example_linear_lsq
     3_basic_example_sampler
     4_realworld_example

src/cofi/_version.py

@@ -7,4 +7,4 @@
 # supported platforms, publish the packages on PyPI, create a Git tag
 # pointing to the commit.
 
-__version__ = "0.1.2.dev9"
+__version__ = "0.1.2.dev10"