chore(release): 1.0.5 #70

nicrie · 2023-07-30T23:52:01Z

new release with following fixes and improvements

fix incorrect dimension in dot product of rotation (close wrong dot product dimension in transform of Rotated MCA #68 )
fix incorrect inverse transform in PCA and MCA (close Inverse transform of MCA fails if standardize = True? #67 )
fix bug in covariance fraction of MCA
inverse_transform of complex methods will always return real values
calling a model with unrecognized parameters will raise an error (close fix ignoring unrecognized parameters #63 )
add a bunch of more test to check mathematical properties of model results (resolves add more test cases #62 )
more extensive documentation (tackling improve documentation #57 )
some more minor code design changes

Use the inverse_transform_scores of the individual DataArrayStacker to unstack the scores within the ListDataArrayStacker. This will help catching special cases where the sample dimension is of length one.

More information added to classes and methods, including references, notes and examples.

Restructure documentation, add model section and some more background

Additional examples in online documentation require advanced plotting and interactivity

Documentation build fails due to excessive memory usage. Potential solution could be using mamba instead of conda, the former is less memory intensive.

In html, interactivity is not straightforward. For simplicity remove all interactive features in the documentation.

cartopy crashes during build with poetry. Don't know how to force conda for installation so I'll go without cartopy for now.

codecov-commenter · 2023-07-31T00:32:39Z

Codecov Report

Merging #70 (c95f658) into main (b39bdaf) will increase coverage by 1.45%.
The diff coverage is 97.98%.

@@            Coverage Diff             @@
##             main      #70      +/-   ##
==========================================
+ Coverage   95.72%   97.17%   +1.45%     
==========================================
  Files          54       63       +9     
  Lines        3319     4351    +1032     
==========================================
+ Hits         3177     4228    +1051     
+ Misses        142      123      -19

Files Changed	Coverage Δ
xeofs/models/_base_model.py	`77.50% <72.22%> (-13.20%)`	⬇️
...data_container/_base_cross_model_data_container.py	`92.68% <89.13%> (+2.85%)`	⬆️
xeofs/data_container/_base_model_data_container.py	`92.15% <89.65%> (+0.49%)`	⬆️
xeofs/data_container/eof_rotator_data_container.py	`92.85% <89.65%> (+3.27%)`	⬆️
xeofs/data_container/mca_rotator_data_container.py	`93.22% <91.42%> (+2.10%)`	⬆️
xeofs/data_container/eof_data_container.py	`95.29% <92.10%> (-0.36%)`	⬇️
xeofs/models/_base_cross_model.py	`88.88% <92.85%> (+3.59%)`	⬆️
xeofs/data_container/mca_data_container.py	`96.32% <94.66%> (+13.39%)`	⬆️
tests/conftest.py	`100.00% <100.00%> (ø)`
..._container/test_base_cross_model_data_container.py	`100.00% <100.00%> (ø)`
... and 21 more

nicrie added 24 commits July 27, 2023 10:51

refactor: use values of modes sorting index

3925ed6

fix: weigh modes with norm before reconstructing

13f42e0

fix: transform of rotator classes

3368ed0

fix: add missing conj for PCA inverse transform

e9d6fe1

fix: inverse_transform enforces real output

5e97160

style: apply rotation matrix in a consistent way

2f5286d

test: test cases for transform, inverse_transform

bee9b1f

fix: remove **kwargs from BaseModel classes

555d0db

ci: lock PSR to 7.x

b5b94e3

refactor: init DataContainer in models

fdd0e78

fix: MCA covariance (fraction)

3e4558d

fix(ListStacker): use DA Stacker to unstack scores

c6479cf

Use the inverse_transform_scores of the individual DataArrayStacker to unstack the scores within the ListDataArrayStacker. This will help catching special cases where the sample dimension is of length one.

test(EOF): check dimensions of components/scores

093cee8

test(MCA): check dimensions of components/scores

a214801

docs: extend and streamline doc strings of methods

a70b9d0

More information added to classes and methods, including references, notes and examples.

docs: improve documentation

ea32e7e

Restructure documentation, add model section and some more background

build: add cartopy and ipywidgets as dev depends

4d4dcd4

Additional examples in online documentation require advanced plotting and interactivity

docs: add a Project description to conf.py

0a5cfe3

docs: use mamba to create doc env

610facf

Documentation build fails due to excessive memory usage. Potential solution could be using mamba instead of conda, the former is less memory intensive.

docs: add mamba to RTD config

33d040b

docs: remove interactivity

6e99b8e

In html, interactivity is not straightforward. For simplicity remove all interactive features in the documentation.

build: update poetry lock

7edfdc9

build: specify cartopy version

ec15384

build: remove cartopy from dev dependencies

c95f658

cartopy crashes during build with poetry. Don't know how to force conda for installation so I'll go without cartopy for now.

nicrie merged commit 1dc9ce6 into main Jul 31, 2023
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(release): 1.0.5 #70

chore(release): 1.0.5 #70

nicrie commented Jul 30, 2023

codecov-commenter commented Jul 31, 2023 •

edited

Loading

chore(release): 1.0.5 #70

chore(release): 1.0.5 #70

Conversation

nicrie commented Jul 30, 2023

codecov-commenter commented Jul 31, 2023 • edited Loading

Codecov Report

codecov-commenter commented Jul 31, 2023 •

edited

Loading