castelao/gsw-rs

Unofficial Gibbs Sea Water Oceanographic Toolbox of TEOS-10 in Rust

gsw-rs's Issues

README could contain more information about the project

Why rewrite in rust? What are the benefits compared to the C implementation? If you are faster, mention that and write how much. If you are “safer”, mention why it matters.

I see that this is answered in doc/talks, but this document is not easily accessible (one has to download the repo and open the file locally). It would be great if the main goals are mentioned directly in the top-level README.md.

Clarify functionality coverage relative to GSW-C

I think that the readme and the joss paper need to say something about the subset of GSW that is already implemented, and perhaps about how much that subset might (or won't) be expanded. In particular, comparison to the current state of the C implementation would be useful. It should be made clear that using the current Rust implementation as a plugin replacement for the C library in the Python implementation will result in considerably reduced functionality. I haven't looked closely enough to figure out how this is handled in your CI when you do plug in the Rust and then run the Python tests.

Unclear relation between tags and crate versions

What is the relation between the crate version (currently 0.1.4) and tags in this repo (currently 0.0.11)?