Merge pull request #106 from MiraGeoscience/hotfix/0.1.3

merge hotfix/0.1.3 to main

Author: sebhmg

.github/workflows/pytest-unix-os.yml

@@ -3,14 +3,13 @@ name: pytest on Unix OS
 on:
   pull_request:
     branches:
-      - master
+      - main
       - release/**
-      - feature/**
       - hotfix/**
   push:
     branches:
-      - development
-      - master
+      - develop
+      - main
       - release/**
       - feature/**
       - hotfix/**

.github/workflows/pytest-windows.yml

@@ -2,10 +2,16 @@ name: pytest on Windows
 
 on:
   pull_request:
+    branches:
+      - develop
+      - main
+      - release/**
+      - feature/**
+      - hotfix/**
   push:
     branches:
-      - development
-      - master
+      - develop
+      - main
       - release/**
       - feature/**
       - hotfix/**

.github/workflows/static-analysis.yml

@@ -3,12 +3,18 @@ name: static analysis
 on:
   pull_request:
     branches:
-      - development
-      - master
+      - develop
+      - main
+      - release/**
+      - feature/**
+      - hotfix/**
   push:
     branches:
-      - development
-      - master
+      - develop
+      - main
+      - release/**
+      - feature/**
+      - hotfix/**
 
 jobs:
   pre-commit:

.pre-commit-config.yaml

@@ -61,6 +61,7 @@ repos:
     -   id: trailing-whitespace
         exclude: \.mdj$
     -   id: check-toml
+    -   id: check-yaml
 #    -   id: check-added-large-files # crashing on some configuration. To be investigated
     -   id: check-case-conflict
     -   id: check-merge-conflict

.rstcheck.cfg

@@ -1,2 +1,3 @@
 [rstcheck]
 ignore_directives=automodule
+report=warning

README.rst

@@ -33,7 +33,7 @@ Install **geoh5py** from PyPI::
 
 Setup for development
 ^^^^^^^^^^^^^^^^^^^^^
-After having cloned the Git repository you will need to setup `Poetry`_.
+After having cloned the Git repository you will need to set up `Poetry`_.
 `Poetry`_ makes it easy to install the dependencies and start a virtual environment.
 
 To install poetry:

docs/content/geoh5_format/analyst/data.rst

@@ -0,0 +1,63 @@
+
+.. _primitive_type:
+
+Primitive Types
+===============
+
+*To be further documented*
+
+Float
+^^^^^
+
+-  Stored as a 1D array of 32-bit float type
+-  No data value: 1.175494351e-38 (FLT_MIN, considering use of NaN)
+
+Integer
+^^^^^^^
+
+-  Stored as a 1D array of 32-bit integer type
+-  No data value: –2147483648 (INT_MIN, considering use of NaN)
+
+Text
+^^^^
+
+-  Stored as a 1D array of UTF-8 encoded, variable-length string type
+-  No data value : empty string
+
+Referenced
+^^^^^^^^^^
+
+-  Stored as a 1D array of 32-bit unsigned integer type (native)
+-  Value map : (1D composite type array dataset - Key (unsigned int),
+   Value (variable-length utf8 string) ) must exist under type
+-  No data value : 0 (key is tied to value “Unknown”)
+
+DateTime
+^^^^^^^^
+
+-  Stored as a 1D array of variable-length strings formatted according
+   to the `ISO 8601 <https://en.wikipedia.org/wiki/ISO_8601>`__ extended
+   specification for representations of UTC dates and times (Qt
+   implementation), taking the form YYYY-MM-DDTHH:mm:ss[Z|[+|-]HH:mm]
+-  No data value : empty string
+
+Filename
+^^^^^^^^
+
+-  Stored as a 1D array of UTF-8 encoded, variable-length string type
+   designating a file name
+-  For each file name within “Data”, an opaque dataset named after the
+   filename must be added under the Data instance, containing a complete
+   binary dump of the file
+-  Different files (under the same object/group) must be saved under
+   different names
+-  No data value : empty string
+
+Blob
+^^^^
+
+-  Stored as a 1D array of 8-bit char type (native) (value ‘0’ or ‘1’)
+-  For each index set to 1, an opaque dataset named after the index
+   (e.g. “1”, “2”, etc) must be added under the Data instance,
+   containing the binary data tied to that index
+-  No data value : 0

docs/content/geoh5_format/analyst/groups.rst

@@ -0,0 +1,55 @@
+.. _ga_group_types:
+
+Group Types
+***********
+
+*To be further documented*
+
+Container
+=========
+
+**UUID : {61FBB4E8-A480-11E3-8D5A-2776BDF4F982}**
+
+Simple container with no special meaning. Default in Geoscience ANALYST.
+
+
+Drillholes
+==========
+
+**UUID : {825424FB-C2C6-4FEA-9F2B-6CD00023D393}**
+
+Container restricted to containing drillhole objects, and which may
+provide convenience functionality for the drillholes within.
+
+
+No Type (Root)
+==============
+
+**UUID : {dd99b610-be92-48c0-873c-5b5946ea2840}**
+
+The ``Root`` group defines the tree structure used in Geoscience ANALYST
+describing the parent-child relationships of entities. If absent, any Groups/Objects/Data
+will be brought into Geoscience ANALYST under the workspace group, still respecting any defined hierarchy links.
+
+
+Tools
+=====
+
+**UUID : {a2befc38-3207-46aa-95a2-16b40117a5d8}**
+
+Group for slicer and label objects.
+
+*Not yet geoh5py implemented*
+
+*To be further documented*
+
+Maxwell
+=======
+
+**UUID : {1c4122b2-8e7a-4ec3-8d6e-c818495adac7}**
+
+Group for Maxwell plate modeling application.
+
+*Not yet geoh5py implemented*
+
+*To be further documented*