Shamo

Changelog

Added

- Added `ObjABC`, `ObjFile` and `ObjDir` classes to provide a base for any savable/loadable object.
- Added `Group`, `Tissue`, `Field`, `Sensor`, `PointSensor` and `FEM` classes to provide a way to generate realistic finite element model based on labelled volumes.
- Added `ProbABC`, `CompABC`, `CompFilePath`, `CompGridSampler`, `CompSensors`, `CompTissueProp`, `CompTissues` and `ProbGetDP` classes to define any problem.
- Added `SolGetDP` class to store information about the solution of a `ProbGetDP` problem.
- Added `DistABC`, `DistConstant`, `DistNormal`, `DistTruncNormal` and `DistUniform` to model random parameters for parametric problems.
- Added `ProbParamABC`, `CompParamTissueProp`, `CompParamValue`, and `ProbParamGetDP` classes to define any parametric problem.
- Added `SolParamABC` and `SolParamGetDP` classes to store information about the solution of a `ProbParamABC` problem.
- Added `ProbEEGLeadfield` and `SolEEGLeadfield` classes to solve the EEG forward problem.
- Added `ProbParamEEGLeadfield`, `SolParamEEGLeadfield` and `SurrEEGLeadfield` classes to solve the parametric EEG forward problem. Also added `SurrEEGLeadfieldToRef` class to evalaute the sensitivity of the EEG leadfield matrix.
- Added `ProbHDTDCSSim` and `SolHDTDCSSim` classes to simulate a HD-tDCS.
- Added `ProbParamHDTDCSSim` and `SolParamHDTDCSSim` classes to simulate a parametric HD-tDCS.
- Added `SurrogateABC` class to define any surrogate model based on a `SolParamABC`.
- Added `SurrScalar` class to define any surrogate model returning a scalar to perform sensitivity analysis.
- Added `shamo-report` command to facilitate bug report.
- Added automated full reference with sphinx autosummary.

Changelog

Hotfix

- Fix MANIFEST error.

Changelog

Added

- TruncatedNormalDistribution to model distributions from paper.

Changelog

Added

- MaternProd kernel to provide proper implementation of the kernel fr further computations.

Changed

- Use Halton sequence rather than quadrature rule to define evaluation points.
- The kernel used in parametric problems is now a compound of a constant kernel and a MaternProd kernel.

Changelog

This release is a bug fixing release for the CI/CD.

Changelog

Added

- Automated docker images build.
- Automated PyPI package build.
- Docstrings for non documented functions.

Changed

- Use [black](https://github.com/psf/black) as a codestyle formatter.
- Use the [src layout](https://blog.ionelmc.ro/2014/05/25/python-packaging/).