Skip to content

Commit

Permalink
Adds drillhole groups and range sliders
Browse files Browse the repository at this point in the history
  • Loading branch information
benk-mira committed Oct 3, 2024
1 parent b3c17e9 commit 070c105
Show file tree
Hide file tree
Showing 12 changed files with 195 additions and 662 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/content/uijson_format/images/group_param.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 65 additions & 1 deletion docs/content/uijson_format/json_objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,14 +157,41 @@ string of a geoh5py group, or a list of type uuids.
{
"my_group": {
"groupType": "{55ed3daf-c192-4d4b-a439-60fa987fe2b8}",
"groupType": [
"{61fbb4e8-a480-11e3-8d5a-2776bdf4f982}",
"{55ed3daf-c192-4d4b-a439-60fa987fe2b8}"
],
"main": true,
"multiSelect": false,
"label": "Select Points or Curve",
"value": ""
}
}
.. figure:: ./images/group_param.png

Drillhole group data Parameter
------------------------------

The Drillhole group data parameter allows users to select a drillhole group and one or more data channels from the group.
The **groupType** and **groupValue** members are required and gives the type uuid of the drillhole group and selected
drillhole group, respectively.

.. code-block:: json
{
"my_group_data": {
"main": true,
"label": "Choose a drillhole group and data",
"groupType": "{825424fb-c2c6-4fea-9f2b-6cd00023d393}",
"groupValue": "",
"multiselect": true,
"value": ""
}
}
.. figure:: ./images/drillhole_group_data_param.png

.. _object_parameter:

Geoscience ANALYST Object Parameter
Expand Down Expand Up @@ -294,6 +321,43 @@ and is float. The **isValue** is set to false upon export in this case.
.. figure:: ./images/data_value_param2.png


Range slider Parameter
-----------------------

The range slider parameter allows users to select a data channel and select a range of values from within the data bounds.
Compared to the data or value parameter, the range slider parameter adds the required **rangeLabel**, **allowComplement**
and **isComplement** members. If allowComplement is true, the user may flip the inclusion from within the bounds to outside
the bounds, and when it is false the icon for flipping the complement is grey and inactive. When saved the ui.json file
will have it's **isComplement**, **property** and **value** updated. The **property** will contain the uuid to the selected
data, whereas the **value** will contain the range values. If is complement is false, then the data are intended to be
included within the bounds, and if it is false they are meant to be included outside the bounds.

.. code-block:: json
{
"my_object": {
"main": true,
"label": "An object",
"meshType": "{4ea87376-3ece-438b-bf12-3479733ded46}",
"value": ""
},
"range_data": {
"main": true,
"label": "Select range",
"allowComplement": true,
"isComplement": false,
"parent": "my_object",
"property": "",
"association": "Cell",
"dataType": "Float",
"value": 0.0,
"rangeLabel": "My range"
}
}
.. figure:: ./images/range_slider_param.png
.. figure:: ./images/range_slider_param_complement.png

Dependencies on other parameters
================================

Expand Down
94 changes: 17 additions & 77 deletions docs/content/user_guide/a_workspace.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -54,7 +54,7 @@
},
{
"cell_type": "code",
"execution_count": 2,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -86,17 +86,9 @@
},
{
"cell_type": "code",
"execution_count": 3,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"<HDF5 file \"my_project.geoh5\" (mode r+)>\n"
]
}
],
"outputs": [],
"source": [
"print(workspace.geoh5)"
]
Expand All @@ -110,17 +102,9 @@
},
{
"cell_type": "code",
"execution_count": 4,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"<Closed HDF5 file>\n"
]
}
],
"outputs": [],
"source": [
"workspace.close()\n",
"\n",
Expand All @@ -138,18 +122,9 @@
},
{
"cell_type": "code",
"execution_count": 5,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"<HDF5 file \"my_project.geoh5\" (mode r+)>\n",
"<Closed HDF5 file>\n"
]
}
],
"outputs": [],
"source": [
"with Workspace(\"my_project.geoh5\") as workspace:\n",
" print(workspace.geoh5)\n",
Expand All @@ -168,17 +143,9 @@
},
{
"cell_type": "code",
"execution_count": 6,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"<_io.BytesIO object at 0x000002BE64F88810>\n"
]
}
],
"outputs": [],
"source": [
"in_memory = Workspace()\n",
"print(in_memory.h5file)"
Expand All @@ -193,17 +160,9 @@
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"<_io.BytesIO object at 0x000002BE66BF7A60>\n"
]
}
],
"outputs": [],
"source": [
"from io import BytesIO\n",
"\n",
Expand All @@ -224,20 +183,9 @@
},
{
"cell_type": "code",
"execution_count": 8,
"execution_count": null,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"<geoh5py.workspace.workspace.Workspace at 0x2be66bb35b0>"
]
},
"execution_count": 8,
"metadata": {},
"output_type": "execute_result"
}
],
"outputs": [],
"source": [
"bytes_ws.save(\"./new_project.geoh5\")"
]
Expand All @@ -251,24 +199,16 @@
},
{
"cell_type": "code",
"execution_count": 9,
"execution_count": null,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"new_project.geoh5\n"
]
}
],
"outputs": [],
"source": [
"print(bytes_ws.h5file)"
]
},
{
"cell_type": "code",
"execution_count": 10,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down
122 changes: 29 additions & 93 deletions docs/content/user_guide/b_core_entities.ipynb

Large diffs are not rendered by default.

Loading

0 comments on commit 070c105

Please sign in to comment.