chore: prepare 0.6.0 release (#196)

* cleanups & changelog

* bump packages versions

* update various deps

* update usage instructions

* uodate current objective

Author: imrn99

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ## To be released
 
+---
+
+## 0.6.0
+
 **This update contains breaking changes**
 
 ### Workspace
@@ -17,6 +21,12 @@
 
 - replace some explicit `panic!` and `unwrap` calls with cleaner alternatives by @imrn99
   in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/174 and https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/176
+- **cleanup error enums** by @imrn99
+  in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/190
+- replace regular prints with prints to stderr for warnings by @imrn99
+  in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/192
+- **turn edge-splitting methods into kernel-crate functions** by @imrn99
+  in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/193
 
 *deps:*
 
@@ -26,6 +36,10 @@
   in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/165
 - bump `egui_dock` from 0.13.0 to 0.14.0 & `bevy_egui` from 0.29.0 to 0.30.0 by @imrn99
   in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/187
+- bump:
+  - `rustversion` from 1.0.15 to 1.0.18
+  - `bevy` from 0.14.1 to 0.14.2
+  - `bevy_mod_outline` from 0.8.1 to 0.8.3
 
 
 ### Published crates
@@ -75,7 +89,7 @@ added in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/160
   in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/168
 
 
-#### honeycomb-kernels (new member)
+#### honeycomb-kernels
 
 <sup>implementations of meshing kernels using combinatorial maps</sup>
 
@@ -105,6 +119,15 @@ added in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/160
 
 - setup grisubal benchmark framework by @imrn99
   in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/164
+- add scripts to streamline the benchmarking process by @imrn99
+  in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/191
+- add benchmarking tools for the grid building routines by @imrn99
+  in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/194
+
+*refactor:*
+
+- **remove irrelevant benchmarks** by @imrn99
+  in https://github.com/LIHPC-Computational-Geometry/honeycomb/pull/195
 
 
 #### honeycomb-examples

Cargo.toml

@@ -13,7 +13,7 @@ members = [
 [workspace.package]
 edition = "2021"
 license = "MIT OR Apache-2.0"
-version = "0.5.0"
+version = "0.6.0"
 homepage = "https://lihpc-computational-geometry.github.io/honeycomb/"
 repository = "https://github.com/LIHPC-Computational-Geometry/honeycomb"
 readme = "README.md"
@@ -27,16 +27,16 @@ authors = [
 
 [workspace.dependencies]
 # members
-honeycomb = { version = "0.5.0", path = "./honeycomb" }
-honeycomb-benches = { version = "0.5.0", path = "./benches" }
-honeycomb-core = { version = "0.5.0", path = "./honeycomb-core" }
-honeycomb-kernels = { version = "0.5.0", path = "./honeycomb-kernels" }
-honeycomb-examples = { version = "0.5.0", path = "./examples" }
-honeycomb-render = { version = "0.5.0", path = "./honeycomb-render" }
+honeycomb = { version = "0.6.0", path = "./honeycomb" }
+honeycomb-benches = { version = "0.6.0", path = "./benches" }
+honeycomb-core = { version = "0.6.0", path = "./honeycomb-core" }
+honeycomb-kernels = { version = "0.6.0", path = "./honeycomb-kernels" }
+honeycomb-examples = { version = "0.6.0", path = "./examples" }
+honeycomb-render = { version = "0.6.0", path = "./honeycomb-render" }
 
 # common
 cfg-if = "1"
-rustversion = "1.0.15"
+rustversion = "1.0.18"
 thiserror = "1.0.64"
 
 # core
@@ -51,10 +51,10 @@ iai-callgrind = "0.14.0"
 rand = "0.9.0-alpha.2"
 
 # render
-bevy = { version = "0.14.1", default-features = false }
+bevy = { version = "0.14.2", default-features = false }
 bevy_egui = "0.30.0"
 bevy_mod_picking = "0.20.1"
-bevy_mod_outline = "0.8.1"
+bevy_mod_outline = "0.8.3"
 egui_dock = "0.14.0"
 
 [profile.bench]

README.md

@@ -6,34 +6,30 @@
 [![Rust Tests](https://github.com/LIHPC-Computational-Geometry/honeycomb/actions/workflows/rust-test.yml/badge.svg)](https://github.com/LIHPC-Computational-Geometry/honeycomb/actions/workflows/rust-test.yml)
 [![codecov](https://codecov.io/github/LIHPC-Computational-Geometry/honeycomb/graph/badge.svg?token=QSN0TWFXO1)](https://codecov.io/github/LIHPC-Computational-Geometry/honeycomb)
 
-Honeycomb aims to provide a safe, efficient and scalable implementation of combinatorial maps for meshing applications. 
-More specifically, the goal is to converge towards a (or multiple) structure(s) adapted to algorithms exploiting GPUs 
+Honeycomb aims to provide a safe, efficient and scalable implementation of combinatorial maps for meshing applications.
+More specifically, the goal is to converge towards a (or multiple) structure(s) adapted to algorithms exploiting GPUs
 and many-core architectures.
 
-The current objective is to implement basic meshing algorithms to evaluate the viability of the implementation & improve
-our structure using Rust's framework to streamline the refactoring and parallelization process.
+The current objective is to profile and benchmark performance of our structure in the context of our
+kernels' implementations, and start introducing concurrency into our code.
 
 
 ## Quickstart
 
-You can add `honeycomb` as a dependency of your project by adding the following lines to its manifest:
+You can add `honeycomb` as a dependency of your project by adding the following lines to its `Cargo.toml`:
 
 ```toml
-# Cargo.toml
-
-[dependencies]
-honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb" }
+# [dependencies]
+honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb", tag = "0.6.0"} # remove tag for master branch build
 ```
 
 Alternatively, you can add the sub-crates that are currently published on crates.io:
 
 ```toml
-# Cargo.toml
-
-[dependencies]
-honeycomb-core = "0.5.0"
-honeycomb-kernels = "0.5.0"
-honeycomb-render = "0.5.0"
+# [dependencies]
+honeycomb-core = "0.6.0"
+honeycomb-kernels = "0.6.0"
+honeycomb-render = "0.6.0"
 ```
 
 
@@ -124,4 +120,4 @@ defined in the Apache-2.0 license, shall be dual licensed as above, without any
 
 [DOCHB]: https://lihpc-computational-geometry.github.io/honeycomb/honeycomb_benches/
 
-[DOCHU]: https://lihpc-computational-geometry.github.io/honeycomb/honeycomb_utils/
+[DOCHU]: https://lihpc-computational-geometry.github.io/honeycomb/honeycomb_utils/

benches/Cargo.toml

@@ -53,11 +53,7 @@ name = "prof-cmap2-sewing-unsewing"
 path = "benches/core/cmap2/link_and_sew.rs"
 harness = false
 
-
-## Criterion benchmarks
-
-
-
+## Builder benchmarks
 
 [[bench]]
 name = "builder"

user-guide/src/index.md

@@ -32,24 +32,20 @@ The current objective is to
 
 #### Rust
 
-To add the main crate to your project, you can add the following lines to its manifest:
+You can add `honeycomb` as a dependency of your project by adding the following lines to its `Cargo.toml`:
 
 ```toml
-# Cargo.toml
-
-[dependencies]
-honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb" }
+# [dependencies]
+honeycomb = { git = "https://github.com/LIHPC-Computational-Geometry/honeycomb", tag = "0.6.0"} # remove tag for master branch build
 ```
 
-Alternatively, you can use the sub-crates:
+Alternatively, you can add the sub-crates that are currently published on crates.io:
 
 ```toml
-# Cargo.toml
-
-[dependencies]
-honeycomb-core = "0.5.0"
-honeycomb-kernels = "0.5.0"
-honeycomb-render = "0.5.0"
+# [dependencies]
+honeycomb-core = "0.6.0"
+honeycomb-kernels = "0.6.0"
+honeycomb-render = "0.6.0"
 ```
 
 Note that if you want to access the latest changes and documentation, you may have to specify a commit instead of a