Skip to content

Commit

Permalink
promote package based on paper proof (#417)
Browse files Browse the repository at this point in the history
* promote quality based on paper proof

* Apply suggestions from code review

Co-authored-by: Kristian Agasøster Haaga <[email protected]>

---------

Co-authored-by: Kristian Agasøster Haaga <[email protected]>
  • Loading branch information
Datseris and kahaaga authored Jun 23, 2024
1 parent be01abd commit 895ec61
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name = "ComplexityMeasures"
uuid = "ab4b797d-85ee-42ba-b621-05d793b346a2"
authors = "Kristian Agasøster Haaga <[email protected]>, George Datseries <[email protected]>"
repo = "https://github.com/juliadynamics/ComplexityMeasures.jl.git"
version = "3.6.3"
version = "3.6.4"

[deps]
Combinatorics = "861a8166-3701-5b0c-9a16-15d98fcdc6aa"
Expand Down
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,15 @@
[![codecov](https://codecov.io/gh/JuliaDynamics/ComplexityMeasures.jl/branch/main/graph/badge.svg?token=6XlPGg5nRG)](https://codecov.io/gh/JuliaDynamics/ComplexityMeasures.jl)
[![Package Downloads](https://img.shields.io/badge/dynamic/json?url=http%3A%2F%2Fjuliapkgstats.com%2Fapi%2Fv1%2Ftotal_downloads%2FComplexityMeasures&query=total_requests&label=Downloads)](http://juliapkgstats.com/pkg/ComplexityMeasures)
[![Package Downloads](https://img.shields.io/badge/dynamic/json?url=http%3A%2F%2Fjuliapkgstats.com%2Fapi%2Fv1%2Ftotal_downloads%2FEntropies&query=total_requests&label=Downloads%20(Entropies))](http://juliapkgstats.com/pkg/Entropies)
[![DOI](https://img.shields.io/badge/DOI:-arXiv.2406.05011-blueviolet.svg)](https://doi.org/10.48550/arXiv.2406.05011)
[![publication](https://img.shields.io/badge/publication-arXiv.2406.05011-blueviolet.svg)](https://doi.org/10.48550/arXiv.2406.05011)

ComplexityMeasures.jl is a software for calculating 1000s of various kinds of
probabilities, entropies, and other so-called _complexity measures_ from a single input dataset. For relational measures across many input datasets see its extension [CausalityTools.jl](https://juliadynamics.github.io/CausalityTools.jl/dev/).
ComplexityMeasures.jl is a Julia-based software for calculating 1000s of various kinds of
probabilities, entropies, and other so-called _complexity measures_ from a single-variable input datasets. For relational measures across many input datasets see its extension [CausalityTools.jl](https://juliadynamics.github.io/CausalityTools.jl/dev/).
If you are a user of other programming languages (Python, R, MATLAB, ...),
you can still use ComplexityMeasures.jl due to Julia's interoperability.
For example, for Python use [`juliacall`](https://pypi.org/project/juliacall/).

A careful comparison with alternative widely used software shows that ComplexityMeasures.jl outclasses the alternatives in several objective aspects of comparison, such as computational performance, overall amount of measures, reliability, and extendability. See the associated publication for more details.

The key features that it provides can be summarized as:

Expand Down

2 comments on commit 895ec61

@kahaaga
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/109622

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v3.6.4 -m "<description of version>" 895ec61c56147e642618e02e2054806dcb087025
git push origin v3.6.4

Please sign in to comment.