Re-export coarse_prof, update readmes and changelog

Author: w1th0utnam3

CHANGELOG.md

@@ -1,8 +1,9 @@
 ## Version 0.3.0
 
  - Move `vtkio` convenience trait implementations in `splashsurf_lib` behind a non-default feature flag (flag `vtk-extras`). Flag is enabled in the CLI crate.
- - Re-export `vtkio` from lib, use this from CLI 
+ - Re-export `vtkio` from lib if feature is enabled and use this from CLI 
  - Move `coarse_prof` usage in `splashsurf_lib` behind a non-default feature flag (flag `profiling`). Flag is enabled in the CLI crate.
+ - Re-export `coarse_prof` from lib if feature is enabled and use this from CLI 
 
 ## Version 0.2.0
 

Cargo.lock

@@ -1,10 +1,14 @@
-# ![splashsurf logo](logos/logo_small.svg "splashsurf")
+# ![splashsurf logo](https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/logos/logo_small.svg "splashsurf")
 [![On crates.io](https://img.shields.io/crates/v/splashsurf)](https://crates.io/crates/splashsurf)
 [![On docs.rs](https://docs.rs/splashsurf_lib/badge.svg)](https://docs.rs/splashsurf_lib)
 [![License: MIT](https://img.shields.io/crates/l/splashsurf)](https://github.com/w1th0utnam3/splashsurf/blob/master/LICENSE)
 ![Build and test GitHub Actions workflow](https://github.com/w1th0utnam3/splashsurf/workflows/Build%20and%20test/badge.svg)
 
-Surface reconstruction for particle data from SPH simulations, written in Rust.
+Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust.
+
+# The `splashsurf` CLI
+
+The following sections mainly focus on the CLI of `splashsurf`. For more information on the library parts, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf_lib/README.md) in the `splashsurf_lib` subfolder.
 
 ## Introduction
 
@@ -128,7 +132,7 @@ With these parameters, a scene with 13353401 particles is reconstructed in nearl
 
 ## Input file formats
 
-TODO: Document more details about the expected formats of supported file extensions
+*TODO: Document more details about the expected format of supported file extensions*
 
 ### Ply
 

README.md

@@ -19,7 +19,6 @@ log = "0.4"
 fern = "0.6"
 chrono = "0.4"
 anyhow = "1.0"
-coarse-prof = "0.2"
 num = "0.3"
 rayon = "1.5"
 ply-rs = "0.1.3"

splashsurf/Cargo.toml

@@ -1,10 +1,14 @@
-# ![splashsurf logo](logos/logo_small.svg "splashsurf")
+# ![splashsurf logo](https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/logos/logo_small.svg "splashsurf")
 [![On crates.io](https://img.shields.io/crates/v/splashsurf)](https://crates.io/crates/splashsurf)
 [![On docs.rs](https://docs.rs/splashsurf_lib/badge.svg)](https://docs.rs/splashsurf_lib)
 [![License: MIT](https://img.shields.io/crates/l/splashsurf)](https://github.com/w1th0utnam3/splashsurf/blob/master/LICENSE)
 ![Build and test GitHub Actions workflow](https://github.com/w1th0utnam3/splashsurf/workflows/Build%20and%20test/badge.svg)
 
-Surface reconstruction for particle data from SPH simulations, written in Rust.
+Surface reconstruction library and CLI for particle data from SPH simulations, written in Rust.
+
+# The `splashsurf` CLI
+
+The following sections mainly focus on the CLI of `splashsurf`. For more information on the library parts, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf_lib/README.md) in the `splashsurf_lib` subfolder.
 
 ## Introduction
 
@@ -128,7 +132,7 @@ With these parameters, a scene with 13353401 particles is reconstructed in nearl
 
 ## Input file formats
 
-TODO: Document more details about the expected formats of supported file extensions
+*TODO: Document more details about the expected format of supported file extensions*
 
 ### Ply
 

splashsurf/README.md

@@ -3,9 +3,8 @@ use std::io::{BufWriter, Write};
 use std::path::Path;
 
 use anyhow::{anyhow, Context};
-use coarse_prof::profile;
 use log::info;
-
+use splashsurf_lib::coarse_prof::profile;
 use splashsurf_lib::nalgebra::Vector3;
 use splashsurf_lib::Real;
 

splashsurf/src/io.rs

@@ -498,6 +498,6 @@ fn log_program_info() {
 /// Returns the coarse_prof::write output as a string
 fn coarse_prof_write_string() -> Result<String, anyhow::Error> {
     let mut buffer = Vec::new();
-    coarse_prof::write(&mut buffer)?;
+    splashsurf_lib::coarse_prof::write(&mut buffer)?;
     Ok(String::from_utf8_lossy(buffer.as_slice()).into_owned())
 }

splashsurf/src/main.rs

@@ -1,6 +1,6 @@
 use anyhow::{anyhow, Context};
-use coarse_prof::profile;
 use log::info;
+use splashsurf_lib::coarse_prof::profile;
 use splashsurf_lib::mesh::PointCloud3d;
 use splashsurf_lib::{density_map, Index, Real};
 

splashsurf/src/reconstruction.rs

@@ -4,4 +4,23 @@ Library for surface reconstruction of SPH particle data
 The library is mainly used by the `splashsurf` command-line tool which is [also available](https://crates.io/crates/splashsurf) on crates.io.
 
 This readme is currently a placeholder that will be extended over time. 
-For now, check the [GitHub repository](https://github.com/w1th0utnam3/splashsurf) for more information. 
+For now, check the [GitHub repository](https://github.com/w1th0utnam3/splashsurf) for more information.
+
+## Usage
+
+*TODO: Describe main "entry points" of the library, parameters, inputs/outputs etc.*
+
+The library re-exports `nalgebra` to avoid version conflicts for users of the library.
+
+## Feature flags
+
+By default none of the following features are enabled to reduce the dependencies introduced by this library. The following feature flags are available for `splashsurf_lib`:
+ 
+ - **vtk-extras**: Enables convenience traits and helper functions to convert the mesh types returned by the library to [`vtkio`](https://crates.io/crates/vtkio) data structures (in particular [`UnstructuredGridPiece`](https://docs.rs/vtkio/latest/vtkio/model/struct.UnstructuredGridPiece.html)) that can be used to easily write the meshes to VTK files (e.g. for viewing them with [Paraview](https://www.paraview.org/)). Check out the documentation of `vtkio` or the [corresponding io module](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf/src/io/vtk_format.rs) of the `splashsurf` CLI for reference.
+ - **profiling**: Enables profiling of the library using [`coarse-prof`](https://crates.io/crates/coarse-prof). Several functions in the library will use the [`profile!`](https://docs.rs/coarse-prof/latest/coarse_prof/macro.profile.html) macro with the function name as an argument to record their runtime. The user of the library can then obtain the profiling data using the functions provided by the `coarse-prof` crate. Note that profiling using this crate might reduce performance for surface reconstructions with a very small number of particles (i.e. only a few hundred).
+
+For each of the features, `splashsurf_lib` re-exports the corresponding dependencies to avoid version conflicts for users of the library.
+
+## The surface reconstruction procedure
+
+*TODO: Describe the surface reconstruction "algorithm" implemented in this crate*

splashsurf_lib/README.md

@@ -2,6 +2,9 @@
 //! Library for surface reconstruction using marching cubes for SPH particle data. Entry point is the [reconstruct_surface] function.
 //!
 
+/// Re-export the version of coarse_prof used by this crate, if profiling is enabled
+#[cfg(feature = "profiling")]
+pub use coarse_prof;
 /// Re-export the version of nalgebra used by this crate
 pub use nalgebra;
 /// Re-export the version of vtkio used by this crate, if vtk support is enabled