New version

[astanziola]

This is going to be the next version and introduces a number of changes (some of them breaking changes), apologies for that.

However, the aim is not to update the API after this one for a very long time and become more open to external contributions.

Planned changes

• [x] params is only accepted as keyword argument. This makes much of the logic inside the core module easier, reduces the time for compilation and makes more explicit how the parameters of each operator are constructed (at the expenses of slightly longer code).
• [x] The second output of an operator is not the params anymore.
• [x] Introduces a new constructor constants() that automatically returns a params initialized for constant values, independent of the operator inputs.
• [x] Deprecates jaxdf.ode.py as it is quite outside the scope of the package. Please consider other libaries, such as https://github.com/patrick-kidger/diffrax
• [x] Several bugfixes
• [x] Updates documentation
• [x] Increases test coverage (aiming for 90%...)
• [x] Exposes private functions that can be of interest and reorganizes

[codecov[bot]]

Codecov Report

Merging #98 (0dae081) into main (0bbaff5) will increase coverage by 28.64%. The diff coverage is 99.01%.

:exclamation: Current head 0dae081 differs from pull request most recent head 82fdae5. Consider uploading reports for the commit 82fdae5 to get more accurate results

@@             Coverage Diff             @@
##             main      #98       +/-   ##
===========================================
+ Coverage   62.46%   91.10%   +28.64%     
===========================================
  Files          12       13        +1     
  Lines         959      911       -48     
===========================================
+ Hits          599      830      +231     
+ Misses        360       81      -279     

Impacted Files	Coverage Δ
jaxdf/operators/functions.py	79.80% <94.59%> (+42.66%)	:arrow_up:
jaxdf/__init__.py	100.00% <100.00%> (ø)
jaxdf/conv.py	100.00% <100.00%> (ø)
jaxdf/core.py	97.67% <100.00%> (+19.04%)	:arrow_up:
jaxdf/discretization.py	93.49% <100.00%> (+8.46%)	:arrow_up:
jaxdf/exceptions.py	100.00% <100.00%> (ø)
jaxdf/operators/differential.py	79.51% <100.00%> (+33.13%)	:arrow_up:
jaxdf/operators/dummy.py	100.00% <100.00%> (+6.25%)	:arrow_up:
jaxdf/operators/linear_algebra.py	100.00% <100.00%> (+25.00%)	:arrow_up:
jaxdf/operators/magic.py	94.26% <100.00%> (+27.19%)	:arrow_up:
... and 8 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.