Note which parts of the API are experimental.

Author: ben-e-whitney

CMakeLists.txt

@@ -8,8 +8,8 @@ endif()
 
 list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
-set(MGARD_VERSION_MAJOR "0")
-set(MGARD_VERSION_MINOR "1")
+set(MGARD_VERSION_MAJOR "1")
+set(MGARD_VERSION_MINOR "0")
 set(MGARD_VERSION_PATCH "0")
 
 set(MGARD_FILE_VERSION_MAJOR "0")

README.md

@@ -1,7 +1,6 @@
 # MGARD [![build status][push workflow badge]][push workflow] [![format status][format workflow badge]][format workflow]
 
 MGARD (MultiGrid Adaptive Reduction of Data) is a technique for multilevel lossy compression of scientific data based on the theory of multigrid methods.
-This is an experimental C++ implementation for integration with existing software; use at your own risk!
 We encourage you to [make a GitHub issue][issue form] if you run into any problems using MGARD, have any questions or suggestions, etc.
 
 [push workflow]: https://github.com/CODARcode/MGARD/actions/workflows/build.yml
@@ -60,8 +59,9 @@ See [the examples directory][examples] for a basic example.
 
 ## Command Line Interface
 
-Assuming the dependencies are met, an executable called `mgard` will be built and installed.
-You can get help with the executable by running the following commands.
+Assuming the dependencies are met, a convenience executable called `mgard` will be built and installed.
+*This executable is an experimental part of the API.*
+You can get help with it by running the following commands.
 
 ```console
 $ mgard --help

include/compress.hpp

@@ -45,6 +45,8 @@ template <std::size_t N, typename Real> class CompressedDataset {
   const Real tolerance;
 
   //! Return a pointer to the compressed dataset.
+  //!
+  //! *The format of the compressed dataset is an experimental part of the API.*
   void const *data() const;
 
   //! Return the size in bytes of the compressed dataset.
@@ -108,6 +110,8 @@ decompress(const CompressedDataset<N, Real> &compressed);
 
 //! Decompress a dataset stored in self-describing format.
 //!
+//! *This is an experimental part of the API.*
+//!
 //!\param data Self-describing compressed dataset.
 //!\param size Size in bytes of compressed dataset.
 std::unique_ptr<unsigned char const[]> decompress(void const *const data,