Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@martinheida
martinheida authored Sep 12, 2024
1 parent 33d31f0 commit 87401a8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# HighVoronoi.jl
A Julia Package for setting up high dimensional (i.e. any dimension >= 2) Finite Volume problems on Voronoi Meshes
A Julia Package for parallelized computing of high dimensional (i.e. any dimension >= 2) Voronoi Meshes and setting up Finite Volume computations on these Meshes

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://martinheida.github.io/HighVoronoi.jl/stable/)
[![Dev(broken)](https://img.shields.io/badge/docs-dev-blue.svg)](https://martinheida.github.io/HighVoronoi.jl/dev/)
Expand All @@ -9,4 +9,4 @@ A Julia Package for setting up high dimensional (i.e. any dimension >= 2) Finite

Refer to the manual for detailed information on how to use.

The new version 1.1.0 has improved performance due to reduced dynamic dispatch issues and reduced redundances in the code. It also includes improved display methods in 2 and 3 dimensions.
The new version 1.3.0 has improved performance due to new internal data structure and parallelization.

4 comments on commit 87401a8

@martinheida
Copy link
Owner Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register

Release notes:

Breaking changes

  • Parallelized computation of Voronoi diagrams
  • Parallelized computation of volumes and integrals
  • Optimized data extraction
  • Optimized internal Data structure
  • Optimized Raycast Algorithm

@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/115050

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 v1.3.1 -m "<description of version>" 87401a818762f4f5ef45374958cd64d3b2b9b2c4
git push origin v1.3.1

@giordano
Copy link

@giordano giordano commented on 87401a8 Sep 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Breaking changes in a patch release is very much against semver, which is what Julia packages are expected to follow. But maybe you didn't mean to classify those changes as "breaking"?

@martinheida
Copy link
Owner Author

Choose a reason for hiding this comment

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

Actually these changes were made to Version 1.3.0 but I forgot to put these information there. Then I found a minor bug so this is now 1.3.1. The changes from 1.2 to 1.3 do not affect the outer appearance to the user except for new options that come with new keywords.
Sorry for the confusion

Please sign in to comment.