morphio 3.3.9__tar.gz → 3.3.10__tar.gz

{morphio-3.3.9 → morphio-3.3.10}/.github/workflows/check-sdist.yml

@@ -13,12 +13,12 @@ jobs:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: 'true'
 
       - name: Set up Python 3.10
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 

{morphio-3.3.9 → morphio-3.3.10}/.github/workflows/clang_format_check.yaml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
         - name: Fetch repository
-          uses: actions/checkout@v3
+          uses: actions/checkout@v4
           with:
              fetch-depth: 2
         - name: Install packages

{morphio-3.3.9 → morphio-3.3.10}/.github/workflows/coverage_test.yaml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Fetch repository
         run: git fetch --prune --unshallow
       - name: Get submodules

{morphio-3.3.9 → morphio-3.3.10}/.github/workflows/docstring_check.yaml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Fetch repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
       - name: Install packages

{morphio-3.3.9 → morphio-3.3.10}/.github/workflows/publish-sdist-wheels.yml

@@ -4,9 +4,9 @@ on: [pull_request, push]
 env:
   apt_options: -o Acquire::Retries=3
 
-  CIBW_BUILD_VERBOSITY: 3
+  CIBW_BUILD_VERBOSITY: 1
   CIBW_BUILD: 'cp*'
-  CIBW_SKIP: 'cp35-* cp36-* cp37-* *-manylinux_i686 *-musllinux_* *-win32'
+  CIBW_SKIP: 'cp35-* cp36-* cp37-* cp38-* *-manylinux_i686 *-musllinux_* *-win32'
   CIBW_BEFORE_TEST: pip install -r {project}/tests/requirement_tests.txt
   CIBW_TEST_COMMAND: pytest -s -v {project}/tests
   UNIXY_HDF5_VERSION: 1.14.3
@@ -21,15 +21,16 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-20.04, macos-11, windows-2022]
+        # macos-13 is an intel runner, macos-14 is apple silicon
+        os: [ubuntu-20.04, windows-2022, macos-13, macos-14]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: 'true'
 
       - name: Install Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.11'
 
@@ -39,7 +40,7 @@ jobs:
 
       - name: Cache HDF5 On Linux/macOS
         if: runner.os == 'Linux' || runner.os == 'macOS'
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         id: cache-hdf5-posix
         env:
           cache-name: cache-hdf5-posix
@@ -61,7 +62,7 @@ jobs:
         run: |
           # used by setup.py to decide if to set `FindHDF5` to use static hdf5 libraries
           export STATIC_HDF5=True
-          export CMAKE_PREFIX_PATH=/opt/hdf5-static/install-/install/
+          export CMAKE_PREFIX_PATH=/opt/hdf5-static/install-x86_64/install/
 
           CIBW_MANYLINUX_X86_64_IMAGE=manylinux2014 python -m cibuildwheel --output-dir dist
           CIBW_MANYLINUX_X86_64_IMAGE=manylinux_2_28 python -m cibuildwheel --output-dir dist
@@ -69,7 +70,7 @@ jobs:
       - name: Build wheels Mac OS
         if: runner.os == 'macOS'
         env:
-          CIBW_ENVIRONMENT_PASS: "STATIC_HDF5 CMAKE_PREFIX_PATH CMAKE_OSX_ARCHITECTURES MACOSX_DEPLOYMENT_TARGET"
+          CIBW_ENVIRONMENT_PASS: "STATIC_HDF5 CMAKE_PREFIX_PATH"
           CIBW_BEFORE_BUILD: |
             # CMake complains if the dependencies come from within the same tree
             # as the source, so we'll just pretend they are elsewhere
@@ -80,25 +81,13 @@ jobs:
           # used by setup.py to decide if to set `FindHDF5` to use static hdf5 libraries
           export STATIC_HDF5=True
 
-          # x86_64 macOS allows for cross compilation; first we do arm64,
-          # only for the 11.0 target; and store in the cache the compiled code...
-          export CIBW_ARCHS_MACOS="arm64"
-          export CMAKE_OSX_ARCHITECTURES="arm64"
-          export MACOSX_DEPLOYMENT_TARGET="11.0"
-          export CMAKE_PREFIX_PATH=/Users/runner/work/src-cache/install-$CIBW_ARCHS_MACOS/install
-          python -m cibuildwheel --output-dir dist
-
-          # ...and now we do both targets for x86_64
-          export CIBW_ARCHS_MACOS="x86_64"
-          export CMAKE_OSX_ARCHITECTURES="x86_64"
-          unset MACOSX_DEPLOYMENT_TARGET
-          export CMAKE_PREFIX_PATH=/Users/runner/work/src-cache/install-$CIBW_ARCHS_MACOS/install
+          export CMAKE_PREFIX_PATH=/Users/runner/work/src-cache/install-`uname -m`/install
           python -m cibuildwheel --output-dir dist
 
       - name: Cache HDF5 On Windows
         if: runner.os == 'Windows'
         id: cache-hdf5-windows
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         env:
           cache-name: cache-hdf5-windows
         with:
@@ -115,13 +104,29 @@ jobs:
 
       - name: Build wheels Windows
         if: runner.os == 'Windows'
-        shell: cmd
         # the v140 toolchain is used, so that fewer vc_redist installs are required
         # some of the information is available here:
         # https://docs.microsoft.com/en-us/cpp/build/building-on-the-command-line
         # but tracking down the 14.0 magic number (and especially newer ones isn't always easy)
         # this has a partial table:
         # https://devblogs.microsoft.com/cppblog/side-by-side-minor-version-msvc-toolsets-in-visual-studio-2017/
+        run: |
+          # vc141 was removed, add it back here: https://github.com/actions/runner-images/issues/9701
+          Set-Location "C:\Program Files (x86)\Microsoft Visual Studio\Installer\"
+          $InstallPath = "C:\Program Files\Microsoft Visual Studio\2022\Enterprise"
+          $componentsToAdd= @(
+            "Microsoft.VisualStudio.Component.VC.v141.x86.x64"
+            "Microsoft.VisualStudio.Component.VC.v141.x86.x64.Spectre"
+            )
+          [string]$workloadArgs = $componentsToAdd | ForEach-Object {" --add " +  $_}
+          $Arguments = ('/c', "vs_installer.exe", 'modify', '--installPath', "`"$InstallPath`"",$workloadArgs, '--quiet', '--norestart', '--nocache')
+          # should be run twice
+          $process = Start-Process -FilePath cmd.exe -ArgumentList $Arguments -Wait -PassThru -WindowStyle Hidden
+          $process = Start-Process -FilePath cmd.exe -ArgumentList $Arguments -Wait -PassThru -WindowStyle Hidden
+
+      - name: Build wheels Windows
+        if: runner.os == 'Windows'
+        shell: cmd
         run: |
           C:\windows\system32\tar.exe xf C:\cache\hdf5\${{ env.WINDOWS_HDF5 }}\hdf5.zip
           start /wait msiexec /a "%cd%\hdf\HDF5-${{ env.WINDOWS_HDF5 }}-win64.msi" /qn TARGETDIR="c:\hdf5\"
@@ -133,9 +138,9 @@ jobs:
           python -m cibuildwheel --output-dir dist
 
       - name: Store wheel as artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: dist
+          name: dist-wheels-${{ matrix.os }}
           path: dist/*.whl
 
   build_sdist:
@@ -144,12 +149,12 @@ jobs:
 
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: 'true'
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 
@@ -166,9 +171,9 @@ jobs:
           pytest -s -v tests
 
       - name: Store sdist as artifact
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: dist
+          name: dist-sdist
           path: dist/*.tar.gz
 
   upload_artifacts:
@@ -180,10 +185,11 @@ jobs:
 
     steps:
       - name: Download artifacts produced during the build_wheels and build_sdist jobs
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
-          name: dist
+          pattern: dist-*
           path: dist/
+          merge-multiple: true
 
       - name: Display structure of downloaded files
         run: ls -R

{morphio-3.3.9 → morphio-3.3.10}/.github/workflows/run-tests.yml

@@ -24,12 +24,12 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: 'true'
 
       - name: Setup python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: '3.10'
 

{morphio-3.3.9 → morphio-3.3.10}/3rdparty/HighFive/CMake/HighFiveConfig.cmake.in

@@ -15,6 +15,8 @@ if(TARGET HighFive)
     return()
 endif()
 
+@PACKAGE_INIT@
+
 # Get HighFive targets
 include("${CMAKE_CURRENT_LIST_DIR}/HighFiveTargets.cmake")
 
@@ -61,8 +63,12 @@ if(HIGHFIVE_USE_XTENSOR AND NOT CMAKE_VERSION VERSION_LESS 3.8)
   set_property(TARGET HighFive APPEND PROPERTY INTERFACE_COMPILE_FEATURES cxx_std_14)
 endif()
 
-message(STATUS "HIGHFIVE @PROJECT_VERSION@: (Re)Detecting Highfive dependencies (HIGHFIVE_USE_INSTALL_DEPS=NO)")
+if(NOT HighFive_FIND_QUIETLY)
+  message(STATUS "HIGHFIVE @PROJECT_VERSION@: (Re)Detecting Highfive dependencies (HIGHFIVE_USE_INSTALL_DEPS=NO)")
+endif()
 include("${CMAKE_CURRENT_LIST_DIR}/HighFiveTargetDeps.cmake")
 foreach(dependency HighFive_libheaders libdeps)
     copy_interface_properties(HighFive ${dependency})
 endforeach()
+
+check_required_components(HighFive)

{morphio-3.3.9 → morphio-3.3.10}/3rdparty/HighFive/CMake/HighFiveTargetDeps.cmake

@@ -26,6 +26,7 @@ if(NOT TARGET libdeps)
   # HDF5
   if(NOT DEFINED HDF5_C_LIBRARIES)
     set(HDF5_PREFER_PARALLEL ${HIGHFIVE_PARALLEL_HDF5})
+    set(HDF5_USE_STATIC_LIBRARIES ${HIGHFIVE_STATIC_HDF5})
     find_package(HDF5 REQUIRED)
   endif()
 
@@ -36,6 +37,8 @@ if(NOT TARGET libdeps)
   target_include_directories(libdeps SYSTEM INTERFACE ${HDF5_INCLUDE_DIRS})
   target_link_libraries(libdeps INTERFACE ${HDF5_LIBRARIES})
   target_compile_definitions(libdeps INTERFACE ${HDF5_DEFINITIONS})
+  target_compile_definitions(libdeps INTERFACE HIGHFIVE_HAS_CONCEPTS=$<BOOL:${HIGHFIVE_HAS_CONCEPTS}>)
+
 
   # Boost
   if(HIGHFIVE_USE_BOOST)

{morphio-3.3.9 → morphio-3.3.10}/3rdparty/HighFive/CMake/HighFiveTargetExport.cmake

@@ -4,7 +4,6 @@ add_library(libheaders INTERFACE)
 
 target_include_directories(libheaders INTERFACE
   "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>"
-  "$<BUILD_INTERFACE:${PROJECT_BINARY_DIR}/include>"
   "$<INSTALL_INTERFACE:include>")
 
 # Combined HighFive

morphio-3.3.10/3rdparty/HighFive/CMake/HighFiveWarnings.cmake

@@ -0,0 +1,43 @@
+if(TARGET HighFiveWarnings)
+    # Allow multiple `include(HighFiveWarnings)`, which would
+    # attempt to redefine `HighFiveWarnings` and fail without
+    # this check.
+    return()
+endif()
+
+add_library(HighFiveWarnings INTERFACE)
+
+if(CMAKE_CXX_COMPILER_ID MATCHES "Clang"
+   OR CMAKE_CXX_COMPILER_ID MATCHES "GNU"
+   OR CMAKE_CXX_COMPILER_ID MATCHES "Intel")
+
+    target_compile_options(HighFiveWarnings
+        INTERFACE
+            -Wall
+            -Wextra
+            -Wshadow
+            -Wnon-virtual-dtor
+            -Wunused
+            -Woverloaded-virtual
+            -Wformat=2
+            -Wconversion
+            -Wsign-conversion
+    )
+
+    if(NOT CMAKE_CXX_COMPILER_ID MATCHES "Intel")
+        target_compile_options(HighFiveWarnings
+            INTERFACE
+                -Wpedantic
+                -Wcast-align
+                -Wdouble-promotion
+        )
+    endif()
+
+    if(HIGHFIVE_HAS_WERROR)
+        target_compile_options(HighFiveWarnings
+            INTERFACE
+                -Werror
+                -Wno-error=deprecated-declarations
+        )
+    endif()
+endif()

{morphio-3.3.9 → morphio-3.3.10}/3rdparty/HighFive/CMakeLists.txt

@@ -5,15 +5,14 @@ else()
   cmake_policy(VERSION 3.13)
 endif()
 
-project(HighFive VERSION 2.7.1)
+project(HighFive VERSION 2.10.0)
 
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/include/highfive/H5Version.hpp.in
-               ${CMAKE_CURRENT_BINARY_DIR}/include/highfive/H5Version.hpp)
+               ${CMAKE_CURRENT_SOURCE_DIR}/include/highfive/H5Version.hpp)
 # INCLUDES
 list(APPEND CMAKE_MODULE_PATH
-  ${PROJECT_SOURCE_DIR}/CMake
-  ${PROJECT_SOURCE_DIR}/CMake/portability
-  ${PROJECT_SOURCE_DIR}/CMake/config)
+  ${CMAKE_CURRENT_SOURCE_DIR}/CMake
+  ${CMAKE_CURRENT_SOURCE_DIR}/CMake/config)
 
 # OPTIONS
 # Compatibility within Highfive 2.x series
@@ -33,9 +32,12 @@ option(HIGHFIVE_USE_OPENCV "Enable OpenCV testing" ${USE_OPENCV})
 option(HIGHFIVE_USE_XTENSOR "Enable xtensor testing" ${USE_XTENSOR})
 option(HIGHFIVE_EXAMPLES "Compile examples" ON)
 option(HIGHFIVE_PARALLEL_HDF5 "Enable Parallel HDF5 support" OFF)
+option(HIGHFIVE_STATIC_HDF5 "Staticly link to HDF5 library" OFF)
 option(HIGHFIVE_BUILD_DOCS "Enable documentation building" ON)
 option(HIGHFIVE_VERBOSE "Set logging level to verbose." OFF)
 option(HIGHFIVE_GLIBCXX_ASSERTIONS "Enable bounds check for STL." OFF)
+option(HIGHFIVE_HAS_CONCEPTS "Print readable compiler errors w/ C++20 concepts" ON)
+option(HIGHFIVE_HAS_WERROR "Convert warnings to errors." OFF)
 
 # Controls if HighFive classes are friends of each other.
 #
@@ -103,17 +105,12 @@ install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/
   DESTINATION "include"
   PATTERN "*.in" EXCLUDE)
 
-# Installation of configured headers
-install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/include/
-  DESTINATION "include")
-
-
 # Preparing local building (tests, examples)
 # ------------------------------------------
 
 # Disable test if Boost was expressly disabled, or if HighFive is a sub-project
 if (NOT CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
-  if(HIGHFIVE_UNIT_TESTS)
+  if(HIGHFIVE_UNIT_TESTS AND NOT HighFive_FIND_QUIETLY)
     message(WARNING "Unit tests have been DISABLED.")
   endif()
   set(HIGHFIVE_UNIT_TESTS FALSE)
@@ -134,15 +131,6 @@ if(HIGHFIVE_UNIT_TESTS)
   endif()
 endif()
 
-
-if(CMAKE_CXX_COMPILER_ID MATCHES "Intel")
-  # ICC gets mad if we shorten "int"s
-  add_definitions("-wd1682")
-endif()
-
-# Set compile time flags _after_ including required dependencies
-include(ReleaseDebugAutoFlags)
-
 if(HIGHFIVE_EXAMPLES)
   add_subdirectory(src/examples)
 endif()

{morphio-3.3.9 → morphio-3.3.10}/3rdparty/HighFive/doc/Doxyfile

@@ -865,6 +865,9 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/../include \
+                         @CMAKE_CURRENT_SOURCE_DIR@/installation.md \
+                         @CMAKE_CURRENT_SOURCE_DIR@/migration_guide.md \
+                         @CMAKE_CURRENT_SOURCE_DIR@/developer_guide.md \
                          @CMAKE_CURRENT_SOURCE_DIR@/../CHANGELOG.md \
                          @CMAKE_CURRENT_SOURCE_DIR@/../README.md
 

morphio-3.3.10/3rdparty/HighFive/doc/developer_guide.md

@@ -0,0 +1,224 @@
+# Developer Guide
+First clone the repository and remember the `--recursive`:
+```bash
+git clone --recursive git@github.com:BlueBrain/HighFive.git
+```
+The instructions to recover if you forgot are:
+```bash
+git submodule update --init --recursive
+```
+
+One remark on submodules: each HighFive commit expects that the submodules are
+at a particular commit. The catch is that performing `git checkout` will not
+update the submodules automatically. Hence, sometimes a `git submodule update
+--recursive` might be needed to checkout the expected version of the
+submodules.
+
+## Compiling and Running the Tests
+The instructions for compiling with examples and unit-tests are:
+
+```bash
+cmake -B build -DCMAKE_BUILD_TYPE={Debug,Release} .
+cmake --build build --parallel
+ctest --test-dir build
+```
+
+You might want to turn off Boost `-DHIGHFIVE_USE_BOOST=Off` or turn on other
+optional dependencies.
+
+## Contributing
+There's numerous HDF5 features that haven't been wrapped yet. HighFive is a
+collaborative effort to slowly cover ever larger parts of the HDF5 library.
+The process of contributing is to fork the repository and then create a PR.
+Please ensure that any new API is appropriately documented and covered with
+tests.
+
+### Code formatting
+The project is formatted using clang-format version 12.0.1 and CI will complain
+if a commit isn't formatted accordingly. The `.clang-format` is at the root of
+the git repository. Conveniently, `clang-format` is available via `pip`:
+
+```bash
+python -m venv venv
+source venv/bin/activate
+
+pip install clang-format==12.0.1
+```
+
+The changed lines can be formatted with `git-clang-format`, e.g. to format all lines changed compared to master:
+
+```bash
+git-clang-format master
+```
+(add `-f` to allow formatting unstaged changes if you trust it to not destroy
+your changes.)
+
+## Releasing HighFive
+Before releasing a new version perform the following:
+
+* Update `CHANGELOG.md` and `AUTHORS.txt` as required.
+* Update `CMakeLists.txt` and `include/highfive/H5Version.hpp`.
+* Follow semantic versioning when deciding the next version number.
+* Check that
+  [HighFive-testing](https://github.com/BlueBrain/HighFive-testing/actions) ran
+  recently.
+
+At this point there should be a commit on master which will be the release
+candidate. Don't tag it yet.
+
+Next step is to update the [HighFive/spack](https://github.com/BlueBrain/spack)
+recipe such that the proposed version points to the release candidate using the
+SHA of that commit. The recipe will look something like this:
+
+```python
+    # ...
+
+    version("2.8.0", commit="094400f22145bcdcd2726ce72888d9d1c21e7068")
+    version("2.7.1", sha256="25b4c51a94d1e670dc93b9b73f51e79b65d8ff49bcd6e5d5582d5ecd2789a249")
+    version("2.7.0", sha256="8e05672ddf81a59ce014b1d065bd9a8c5034dbd91a5c2578e805ef880afa5907")
+    # ...
+```
+
+Push the changes to the BlueBrain spack repository. This will trigger building
+all BBP dependencies of HighFive, i.e. another integration test. Don't actually
+merge this commit yet.
+
+Now that we know that the integration test ran, and all BBP software can be
+built with the proposed version of HighFive, we can proceed and create the
+release. Once this is done perform a final round of updates:
+
+* Download the archive (`*.tar.gz`) and compute its SHA256.
+* Update BlueBrain Spack recipe to use the archive and not the Git commit.
+* Update the upstream Spack recipe.
+
+## Writing Tests
+### Generate Multi-Dimensional Test Data
+Input array of any dimension and type can be generated using the template class
+`DataGenerator`. For example:
+```
+auto dims = std::vector<size_t>{4, 2};
+auto values = testing::DataGenerator<std::vector<std::array<double, 2>>::create(dims);
+```
+Generates an `std::vector<std::array<double, 2>>` initialized with suitable
+values.
+
+If "suitable" isn't specific enough, one can specify a callback:
+```
+auto callback = [](const std::vector<size_t>& indices) {
+    return 42.0;
+}
+
+auto values = testing::DataGenerator<std::vector<double>>::create(dims, callback);
+```
+
+The `dims` can be generated via `testing::DataGenerator::default_dims` or by
+using `testing::DataGenerator::sanitize_dims`. Remember, that certain
+containers are fixed size and that we often compute the number of elements by
+multiplying the dims.
+
+### Generate Scalar Test Data
+To generate a single "suitable" element use template class `DefaultValues`, e.g.
+```
+auto default_values = testing::DefaultValues<double>();
+auto x = testing::DefaultValues<double>(indices);
+```
+
+### Accessing Elements
+To access a particular element from an unknown container use the following trait:
+```
+using trait = testing::ContainerTraits<std::vector<std::array<int, 2>>;
+// auto x = values[1][0];
+auto x = trait::get(values, {1, 0});
+
+// values[1][0] = 42.0;
+trait::set(values, {1, 0}, 42.0);
+```
+
+### Utilities For Multi-Dimensional Arrays
+Use `testing::DataGenerator::allocate` to allocate an array (without filling
+it) and `testing::copy` to copy an array from one type to another. There's
+`testing::ravel`, `testing::unravel` and `testing::flat_size` to compute the
+position in a flat array from a multi-dimensional index, the reverse and the
+number of element in the multi-dimensional array.
+
+### Deduplicating DataSet and Attribute
+Due to how HighFive is written testing `DataSet` and `Attribute` often requires
+duplicating the entire test code because somewhere a `createDataSet` must be
+replaced with `createAttribute`. Use `testing::AttributeCreateTraits` and
+`testing::DataSetCreateTraits`. For example,
+```
+template<class CreateTraits>
+void check_write(...) {
+    // Same as one of:
+    //   file.createDataSet(name, values);
+    //   file.createAttribute(name, values);
+    CreateTraits::create(file, name, values);
+}
+```
+
+### Test Organization
+#### Multi-Dimensional Arrays
+All tests for reading/writing whole multi-dimensional arrays to datasets or
+attributes belong in `tests/unit/tests_high_five_multi_dimensional.cpp`. This
+includes write/read cycles; checking all the generic edges cases, e.g. empty
+arrays and mismatching sizes; and checking non-reallocation.
+
+Read/Write cycles are implemented in two distinct checks. One for writing and
+another for reading. When checking writing we read with a "trusted"
+multi-dimensional array (a nested `std::vector`), and vice-versa when checking
+reading. This matters because certain bugs, like writing a column major array
+as if it were row-major can't be caught if one reads it back into a
+column-major array.
+
+Remember, `std::vector<bool>` is very different from all other `std::vector`s.
+
+Every container `template<class T> C;` should at least be checked with all of
+the following `T`s that are supported by the container: `bool`, `double`,
+`std::string`, `std::vector`, `std::array`. The reason is `bool` and
+`std::string` are special, `double` is just a POD, `std::vector` requires
+dynamic memory allocation and `std::array` is statically allocated.
+
+Similarly, each container should be put inside an `std::vector` and an
+`std::array`.
+
+#### Scalar Data Set
+Write-read cycles for scalar values should be implemented in
+`tests/unit/tests_high_five_scalar.cpp`.
+
+#### Data Types
+Unit-tests related to checking that `DataType` API, go in
+`tests/unit/tests_high_data_type.cpp`.
+
+#### Selections
+Anything selection related goes in `tests/unit/test_high_five_selection.cpp`.
+This includes things like `ElementSet` and `HyperSlab`.
+
+#### Strings
+Regular write-read cycles for strings are performed along with the other types,
+see above. This should cover compatibility of `std::string` with all
+containers. However, additional testing is required, e.g. character set,
+padding, fixed vs. variable length. These all go in
+`tests/unit/test_high_five_string.cpp`.
+
+#### Specific Tests For Optional Containers
+If containers, e.g. `Eigen::Matrix` require special checks those go in files
+called `tests/unit/test_high_five_*.cpp` where `*` is `eigen` for Eigen.
+
+#### Memory Layout Assumptions
+In HighFive we make assumptions about the memory layout of certain types. For
+example, we assume that
+```
+auto array = std::vector<std::array<double, 2>>(n);
+doube * ptr = (double*) array.data();
+```
+is a sensible thing to do. We assume similar about `bool` and
+`details::Boolean`. These types of tests go into
+`tests/unit/tests_high_five_memory_layout.cpp`.
+
+#### H5Easy
+Anything `H5Easy` related goes in files with the appropriate name.
+
+#### Everything Else
+What's left goes in `tests/unit/test_high_five_base.cpp`. This covers opening
+files, groups, dataset or attributes; checking certain pathological edge cases;
+etc.