search

JuliaDynamics / ComplexityMeasures.jl

Estimators for probabilities, entropies, and other complexity measures derived from data in the context of nonlinear dynamics and complex systems
MIT License
56 stars 14 forks source link

Finish tutorial and API reference for v3 #347

Closed Datseris closed 9 months ago

Datseris commented 9 months ago

This needs the pretty printing to be finished. There is also the matter of resolving this comment: https://github.com/JuliaDynamics/ComplexityMeasures.jl/pull/341#issuecomment-1862365859

kahaaga commented 9 months ago

There is also the matter of resolving this comment: https://github.com/JuliaDynamics/ComplexityMeasures.jl/pull/341#issuecomment-1862365859

I opened an issue for this comment, and I am working on a PR for it.

kahaaga commented 9 months ago

FYi, @Datseris

Since we're basing everything around probabilities_and_outcomes, this needs to be consistent throughout the code, including allprobabilities_and_outcomes, and for all ProbabilitiesEstimators. I'm almost done with the necessary refactoring.

codecov[bot] commented 9 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (68ad248) 88.87% compared to head (1b795bb) 89.05%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #347 +/- ## ========================================== + Coverage 88.87% 89.05% +0.18% ========================================== Files 79 79 Lines 2185 2221 +36 ========================================== + Hits 1942 1978 +36 Misses 243 243 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

kahaaga commented 9 months ago

From what I can see in the lists of issues, we've now sorted out everything needed for the 3.0 branch. Anything else you want to add before we merge and release 3.0, @Datseris?

Datseris commented 9 months ago

I can't approve my own PRs so you have to merge this one ! I want to go through the list of issues one last time before tagging if that's okay.

kahaaga commented 9 months ago

Sure, I'll have a look at this later today and merge if it looks okay

Datseris commented 9 months ago

I agree this is really incredible if one takes a look to what exists out there. Most packages on the field don't even have tests... It will be difficult to bring across how huge of a step up this software is. I am also looking forwards to finishing the paper!

Thank you for your hard work and happy new year!