[rozyczko]

Summary

EasyScience 3.0 is a major, breaking release. It removes the legacy object model and its compatibility layers, and replaces them with a smaller, more consistent set of base classes.

Breaking changes

Base classes and object model

• ObjBase, BasedBase, CollectionBase, the old Descriptor hierarchy and the Legacy directory are removed.
• DescriptorBase is now a ModelBase class, and NewBase is renamed EasyBase.
• CollectionBase is replaced by EasyList (Replace CollectionBase in MultiFitter with EasyList #304). EasyList now accepts a list of parameters (Fix EasyList to accept a list of parameters #307) and is used by MultiFitter (Replaced CollectionBase with EasyList #304 #305).
• The name attribute is removed (308 remove name #313), along with the unused descriptor_any_type (Remove Descriptor_any_type or move it to legacy #318).
• Renaming an object now drops its original unique_name. Map is replaced by ObjectRegistry.

Serialization

• type_dict / TypedDict is removed (Remove type_dict and related logic #207, Remove typedict #338).

• _REDIRECT is removed (Remove _REDIRECT; serializer relies on _arg_spec only #319). The serializer relies only on _arg_spec.

• serializer_base moves from io/ to base_classes/.

• Fitting and minimizers

• The interface factory is removed.

• get_free_parameters is removed (Move get_free_parameters to minimizers and remove get_fit_parameters from ModelBase #334, removed get_free_parameters #334 #346).

• Minimizers no longer take an optional parameter list.

• AvailableMinimizers is replaced by the Minimizers enum, and string-based minimizer indexing is gone (Removal of string-based minimizers #347, removed strings in minimizer indexing mechanism #347 #348).

• Fixed two LMFit wrapper issues (No error coming back from minimizers is masked by 0.0 #301, LMFit powell/cobyla crash with ftol when a tolerance is set #302).

Sampler

The sampler is restructured and is now fully Fitter-agnostic (#280, #287, #310).

Removed features

• Undo/redo is removed (Removed undo #342).
• The built-in Polynomial model is removed.
• The if machinery is removed (Remove InterfaceFactory #294, Removed interface factory #333).

Other behaviour changes

• Fixed behaviour when Parameter is assigned None and there is no covariance (fixed two minor issues in the LMFit wrapper. #301 and #302 #303).
• Parameter.repr now shows dependent parameters (Update Parameter repr to show dependent parameters #330).

[codecov]

Codecov Report

❌ Patch coverage is 98.35255% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.68%. Comparing base (1dbaadc) to head (b92302b).

Files with missing lines	Patch %	Lines
src/easyscience/fitting/engine_base.py	95.06%	4 Missing ⚠️
src/easyscience/fitting/reshaping.py	96.61%	2 Missing ⚠️
src/easyscience/fitting/fitter.py	92.30%	1 Missing ⚠️
.../easyscience/fitting/minimizers/minimizer_bumps.py	98.00%	1 Missing ⚠️
src/easyscience/variable/descriptor_number.py	94.11%	1 Missing ⚠️
src/easyscience/variable/parameter.py	96.29%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #352      +/-   ##
===========================================
+ Coverage    83.24%   92.68%   +9.43%     
===========================================
  Files           63       47      -16     
  Lines         5324     3375    -1949     
===========================================
- Hits          4432     3128    -1304     
+ Misses         892      247     -645     

Flag	Coverage Δ
unittests	92.68% <98.35%> (+9.43%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/easyscience/__init__.py	100.00% <100.00%> (ø)
src/easyscience/base_classes/__init__.py	100.00% <100.00%> (ø)
src/easyscience/base_classes/easy_base.py	98.59% <100.00%> (ø)
src/easyscience/base_classes/easy_list.py	96.95% <100.00%> (+0.03%)	⬆️
src/easyscience/base_classes/model_base.py	100.00% <100.00%> (ø)
src/easyscience/base_classes/serializer_base.py	98.15% <100.00%> (ø)
src/easyscience/fitting/__init__.py	100.00% <ø> (ø)
src/easyscience/fitting/minimizers/__init__.py	100.00% <100.00%> (ø)
...science/fitting/minimizers/bumps_utils/__init__.py	100.00% <100.00%> (ø)
...yscience/fitting/minimizers/bumps_utils/problem.py	100.00% <100.00%> (ø)
... and 29 more

... and 1 file with indirect coverage changes

[damskii9992]

This needs to go through develop first.

[rozyczko]

This needs to go through develop first.

Does it, though?

This is breaking change so wouldn't it make more sense to go directly to master and then do the update into develop?

[damskii9992]

This needs to go through develop first.

Does it, though?

This is breaking change so wouldn't it make more sense to go directly to master and then do the update into develop?

For the sake of our CI it needs to go through develop . . .

But I imagine we do an immediate PR to master from develop after merging this into develop.