From 2212dbf5ab6a2dd8b7aacdedf050abd573c871b5 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 09:22:13 -0400 Subject: [PATCH 01/21] #112: Add BAG_VertUncertCode_noaaProduct_2024 vertical uncertainty code --- configdata/ISO19139/bag/bagCodelists.xml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/configdata/ISO19139/bag/bagCodelists.xml b/configdata/ISO19139/bag/bagCodelists.xml index f344237e4b..9137afe503 100644 --- a/configdata/ISO19139/bag/bagCodelists.xml +++ b/configdata/ISO19139/bag/bagCodelists.xml @@ -116,6 +116,13 @@ productUncert + + + NOAA standard product uncertainty version 2024 + https://repository.library.noaa.gov/view/noaa/61830 + noaaProduct_2024 + + Estimated standard deviation based on historical/archive data From ae8e2a5ddfbf44ef2d317db95ef84b417bfaadd7 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 13:03:22 -0400 Subject: [PATCH 02/21] #112: Add BAG_VertUncertCode_noaaProduct_2024 vertical uncertainty code; order Table 1.1 to match that of BAG_VertUncertCode in bagCodelists.xml; Update Table 1.2 so that code definitions match those of BAG_DepthCorreCode in bagCodelists.xml --- docs/sphinx/source/fsd/FSD-BAGStructure.md | 26 ++++++++++++---------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/sphinx/source/fsd/FSD-BAGStructure.md b/docs/sphinx/source/fsd/FSD-BAGStructure.md index 6d1d665b8a..58b93fe3b3 100644 --- a/docs/sphinx/source/fsd/FSD-BAGStructure.md +++ b/docs/sphinx/source/fsd/FSD-BAGStructure.md @@ -56,27 +56,29 @@ The ISO 19115 object model provided most of the needed classes and attributes re | Enumerated Value | Description | | :-------------------- |:----------------------------------------------------------------------------------------------------------------------------------------| -| Unknown | "Unknown" - The uncertainty layer is an unknown type | -| Raw_Std_Dev | "Raw Standard Deviation" - Raw standard deviation of soundings that contributed to the node | -| CUBE_Std_Dev | "CUBE Standard Deviation" - Standard deviation of soundings captured by a CUBE hypothesis (i.e., CUBE’s standard output of uncertainty) | -| Product_Uncert | "Product Uncertainty" - NOAA standard product uncertainty V1.0 (a blend of CUBE uncertainty and other measures). | -| Historical_Std_Dev | "Historical Standard Deviation" – Estimated standard deviation based on historical/archive data. | +| BAG_VertUncertCode_rawStdDev | "Raw Standard Deviation" - Raw standard deviation of soundings that contributed to the node | +| BAG_VertUncertCode_cubeStdDev | "CUBE Standard Deviation" - Standard deviation of soundings captured by a CUBE hypothesis (i.e., CUBE’s standard output of uncertainty) | +| BAG_VertUncertCode_productUncert | "Product Uncertainty" - NOAA standard product uncertainty V1.0 (a blend of CUBE uncertainty and other measures). | +| BAG_VertUncertCode_noaaProduct_2024 | "Product Uncertainty 2024" - NOAA standard product uncertainty version 2024 (https://repository.library.noaa.gov/view/noaa/61830) | +| BAG_VertUncertCode_historicalStdDev | "Historical Standard Deviation" – Estimated standard deviation based on historical/archive data. | +| BAG_VertUncertCode_averageTPE | "Average TPE" - Average of all of the contributing sounding TPE's within the node. | +| BAG_VertUncertCode_unknown | "Unknown" - The uncertainty layer is an unknown type | Secondly, the `trackingId` extension allows internal Tracking List entries to be associated with a unique entry in the metadata so that the changes can be properly attributed, described and easily referenced. -Thirdly, the `depthCorrectionType` extension was added to allow the BAG file to accurately describe the correction performed on the data. Table 1.2 shows the list of supported values as of the 1.1 release. +Thirdly, the `depthCorrectionType` extension was added to allow the BAG file to accurately describe the correction performed on the data. Table 1.2 shows the list of supported values as of the 2.0 release. **Table 1.2: Table of depth correction types.** | Enumerated Value | Description | | :-------------------- | :------------ | -| True_Depth | “True Depth” – Depth corrected for sound velocity | -| Nominal_Depth_Meters | “Nominal at 1500m/s”- Depth at assumed sound velocity of 1500m/s | -| Nominal_Depth_Feet | “Nominal at 4800ft/s” – Depth at assumed sound velocity of 4800ft/s | -| Corrected_Carters | “Corrected via Carter’s Tables” – Corrected depth using Carter’s tables | -| Corrected_Matthews | “Corrected via Matthew’s Tables” – Corrected depth using Matthew’s tables | -| Unknown | “Unknown” – Unknown depth correction type or mixture of above types | +| BAG_DepthCorrectCode_trueDepth | “True Depth” – Depth corrected for sound velocity | +| BAG_DepthCorrectCode_nominalDepthMetre | “Nominal at 1500m/s”- Depth at assumed sound velocity of 1500m/s | +| BAG_DepthCorrectCode_nominalDepthFeet | “Nominal at 4800ft/s” – Depth at assumed sound velocity of 4800ft/s | +| BAG_DepthCorrectCode_correctedCarters | “Corrected via Carter’s Tables” – Corrected depth using Carter’s tables | +| BAG_DepthCorrectCode_correctedMatthews | “Corrected via Matthew’s Tables” – Corrected depth using Matthew’s tables | +| BAG_DepthCorrectCode_unknown | “Unknown” – Unknown depth correction type or mixture of above types | ### Common Encoding From 48e362d3107ed1566f00247745c9824820055fad Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 13:10:19 -0400 Subject: [PATCH 03/21] #112: Update BAG library version for release 2.0.3 --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ef0b3364a0..0e3630144d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ # CMake 3.15+ needed for SWIG version 4.0+ support. 3.18+ needed for Development.Module # sub-component support for FindPyton. cmake_minimum_required(VERSION 3.18) -project(OpenNavSurf-BAG LANGUAGES C CXX VERSION 2.0.1) +project(OpenNavSurf-BAG LANGUAGES C CXX VERSION 2.0.3) set(CMAKE_CXX_STANDARD 14) # SWIG: use standard target name. From 0785fbbe45c53239cd66c59c787e98bd65bfeda5 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 14:31:38 -0400 Subject: [PATCH 04/21] #112: Update readthedocs python build version to 3.12 --- docs/readthedocs/environment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/environment.yml b/docs/readthedocs/environment.yml index 868a56c7c9..d7d0adc5f4 100644 --- a/docs/readthedocs/environment.yml +++ b/docs/readthedocs/environment.yml @@ -2,7 +2,7 @@ name: readthedocs channels: - conda-forge dependencies: - - python=3.9 + - python=3.12 - gxx_linux-64 - cmake - ninja From f1c2ddfb712524b9f4554eef97ada7eec1c74785 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 15:27:31 -0400 Subject: [PATCH 05/21] #112: Streamline buildthedocs config in effort to fix broken build --- .readthedocs.yaml | 4 ++-- docs/readthedocs/build.bash | 4 ---- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 47b02d71e4..d73e1136e7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,9 +10,9 @@ conda: # Set the version of Python and other tools you might need build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: "3.9" + python: "miniconda3-3.12-24.1" commands: - bash docs/readthedocs/build.bash diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 51f2bf365b..73b8da7f53 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,8 +1,4 @@ #!/usr/bin/bash -wget -q https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh -bash miniconda.sh -b -p $(pwd)/miniconda -source "$(pwd)/miniconda/etc/profile.d/conda.sh" -hash -r conda env create -q --file docs/readthedocs/environment.yml conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON From c450cb5ea822aa985f56672c6d2b987d8ea3efb7 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 15:34:41 -0400 Subject: [PATCH 06/21] #112: readthedocs: Update conda invocation --- docs/readthedocs/build.bash | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 73b8da7f53..2e850d464b 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,4 +1,5 @@ #!/usr/bin/bash +conda init bash conda env create -q --file docs/readthedocs/environment.yml conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON From 9044bf72d32946f8196a1997d3f5615a7d43120c Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 15:40:38 -0400 Subject: [PATCH 07/21] #112: readthedocs: Update conda invocation, attempt 2 --- docs/readthedocs/build.bash | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 2e850d464b..5f75e3be87 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,6 +1,6 @@ #!/usr/bin/bash -conda init bash conda env create -q --file docs/readthedocs/environment.yml +conda init bash conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON cmake --build build -v From 4f763a9473020cd1b0448b18827d73b6c49b17a3 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 20:38:36 -0400 Subject: [PATCH 08/21] #112: readthedocs: Update conda invocation, attempt 3 --- .readthedocs.yaml | 6 +++--- docs/readthedocs/build.bash | 4 +--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d73e1136e7..249365e165 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,9 +5,6 @@ # Required version: 2 -conda: - environment: docs/readthedocs/environment.yml - # Set the version of Python and other tools you might need build: os: ubuntu-24.04 @@ -16,6 +13,9 @@ build: commands: - bash docs/readthedocs/build.bash +conda: + environment: docs/readthedocs/environment.yml + # Build documentation in the docs/ directory with Sphinx #sphinx: # configuration: docs/readthedocs/conf.py diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 5f75e3be87..462510f8df 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,7 +1,5 @@ #!/usr/bin/bash -conda env create -q --file docs/readthedocs/environment.yml -conda init bash -conda activate readthedocs +set -eu -o pipefail cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON cmake --build build -v mkdir -p _readthedocs/html/ From 0a1bac4c61fd3d29c887f78bfbbdd2302b7d6378 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 20:46:19 -0400 Subject: [PATCH 09/21] #112: readthedocs: Update conda invocation, attempt 4 --- docs/readthedocs/build.bash | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 462510f8df..8097199549 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,5 +1,9 @@ #!/usr/bin/bash set -eu -o pipefail +conda init bash +source activate base +conda env create -q --file docs/readthedocs/environment.yml +conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON cmake --build build -v mkdir -p _readthedocs/html/ From e7c6dd8f689202288325ae66e756128eb5ecf701 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 20:48:26 -0400 Subject: [PATCH 10/21] #112: readthedocs: Update conda invocation, attempt 5 --- docs/readthedocs/build.bash | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 8097199549..56d47b3285 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,7 +1,7 @@ #!/usr/bin/bash set -eu -o pipefail conda init bash -source activate base +source ${HOME}/.bashrc conda env create -q --file docs/readthedocs/environment.yml conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON From 88af6622377cbbd45d9a8c7b5298ea1e57b1cca1 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 20:50:43 -0400 Subject: [PATCH 11/21] #112: readthedocs: Update conda invocation, attempt 6 --- docs/readthedocs/build.bash | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 56d47b3285..bf7a7af255 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -3,6 +3,7 @@ set -eu -o pipefail conda init bash source ${HOME}/.bashrc conda env create -q --file docs/readthedocs/environment.yml +conda init conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON cmake --build build -v From 90f7356cda3dd29b42bae997a4aceb1b90b3601a Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 21:45:59 -0400 Subject: [PATCH 12/21] #112: readthedocs: Update conda invocation, attempt 7 --- docs/readthedocs/build.bash | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index bf7a7af255..87ee3af05b 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,9 +1,8 @@ #!/usr/bin/bash set -eu -o pipefail +conda env create -q --file docs/readthedocs/environment.yml conda init bash source ${HOME}/.bashrc -conda env create -q --file docs/readthedocs/environment.yml -conda init conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON cmake --build build -v From 64e9cf682b269fb27da841d5e1bf9c8575f50dc6 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 21:47:44 -0400 Subject: [PATCH 13/21] #112: readthedocs: Update conda invocation, attempt 8 --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 249365e165..80ae219508 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,8 +13,8 @@ build: commands: - bash docs/readthedocs/build.bash -conda: - environment: docs/readthedocs/environment.yml +#conda: +# environment: docs/readthedocs/environment.yml # Build documentation in the docs/ directory with Sphinx #sphinx: From e9501c9fa8b7fa949a7ca210af226992227c54df Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:03:00 -0400 Subject: [PATCH 14/21] #112: readthedocs: Update conda invocation, attempt 9 --- .readthedocs.yaml | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 80ae219508..fac4e63922 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,12 +9,17 @@ version: 2 build: os: ubuntu-24.04 tools: - python: "miniconda3-3.12-24.1" + python: "mambaforge-latest" commands: - - bash docs/readthedocs/build.bash + - cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON + - cmake --build build -v + - mkdir -p _readthedocs/html/ + - ls -R build/docs/sphinx + - cp -r build/docs/sphinx/* _readthedocs/html/ + - ls -R _readthedocs/html -#conda: -# environment: docs/readthedocs/environment.yml +conda: + environment: docs/readthedocs/environment.yml # Build documentation in the docs/ directory with Sphinx #sphinx: From cf2d7d8b2c93b64731dccebf5160a17d1ef2a1fa Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:13:27 -0400 Subject: [PATCH 15/21] #112: readthedocs: Update conda invocation, attempt 10 --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index fac4e63922..a164f2caa2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-24.04 tools: - python: "mambaforge-latest" + python: "3" commands: - cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON - cmake --build build -v From 09e17f4fe8cf2a55d58ceb452336fa14d3c09403 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:35:55 -0400 Subject: [PATCH 16/21] #112: readthedocs: Update conda invocation, attempt 11 --- .readthedocs.yaml | 7 +------ docs/readthedocs/build.bash | 6 ++++-- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a164f2caa2..c72f25fdf8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,12 +11,7 @@ build: tools: python: "3" commands: - - cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON - - cmake --build build -v - - mkdir -p _readthedocs/html/ - - ls -R build/docs/sphinx - - cp -r build/docs/sphinx/* _readthedocs/html/ - - ls -R _readthedocs/html + - bash docs/readthedocs/build.bash conda: environment: docs/readthedocs/environment.yml diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index 87ee3af05b..a1a407de64 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,8 +1,10 @@ #!/usr/bin/bash set -eu -o pipefail +wget -q https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh +bash miniconda.sh -b -p $(pwd)/miniconda +source "$(pwd)/miniconda/etc/profile.d/conda.sh" +hash -r conda env create -q --file docs/readthedocs/environment.yml -conda init bash -source ${HOME}/.bashrc conda activate readthedocs cmake -G Ninja -DCMAKE_BUILD_TYPE=Release -B build -S . -DBAG_BUILD_PYTHON:BOOL=ON -DBAG_BUILD_DOCS:BOOL=ON cmake --build build -v From b1e3fd96bfaa97f08706a15ddfae669d1f52a85f Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:38:00 -0400 Subject: [PATCH 17/21] #112: readthedocs: Update conda invocation, attempt 12 --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c72f25fdf8..fa767d301e 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,9 +7,9 @@ version: 2 # Set the version of Python and other tools you might need build: - os: ubuntu-24.04 + os: ubuntu-22.04 tools: - python: "3" + python: "3.9" commands: - bash docs/readthedocs/build.bash From da83ff6dabddcb90d1298d0d0fd758ad342bf54c Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:38:56 -0400 Subject: [PATCH 18/21] #112: readthedocs: Update conda invocation, attempt 13 --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index fa767d301e..197ec20bb3 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,8 +13,8 @@ build: commands: - bash docs/readthedocs/build.bash -conda: - environment: docs/readthedocs/environment.yml +#conda: +# environment: docs/readthedocs/environment.yml # Build documentation in the docs/ directory with Sphinx #sphinx: From 6edad8033ccad895a9f8289f2af811dd55f2d8df Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:42:06 -0400 Subject: [PATCH 19/21] #112: readthedocs: Update conda invocation, attempt 14 --- .readthedocs.yaml | 6 +++--- docs/readthedocs/build.bash | 1 - docs/readthedocs/environment.yml | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 197ec20bb3..47b02d71e4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,6 +5,9 @@ # Required version: 2 +conda: + environment: docs/readthedocs/environment.yml + # Set the version of Python and other tools you might need build: os: ubuntu-22.04 @@ -13,9 +16,6 @@ build: commands: - bash docs/readthedocs/build.bash -#conda: -# environment: docs/readthedocs/environment.yml - # Build documentation in the docs/ directory with Sphinx #sphinx: # configuration: docs/readthedocs/conf.py diff --git a/docs/readthedocs/build.bash b/docs/readthedocs/build.bash index a1a407de64..51f2bf365b 100644 --- a/docs/readthedocs/build.bash +++ b/docs/readthedocs/build.bash @@ -1,5 +1,4 @@ #!/usr/bin/bash -set -eu -o pipefail wget -q https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh bash miniconda.sh -b -p $(pwd)/miniconda source "$(pwd)/miniconda/etc/profile.d/conda.sh" diff --git a/docs/readthedocs/environment.yml b/docs/readthedocs/environment.yml index d7d0adc5f4..868a56c7c9 100644 --- a/docs/readthedocs/environment.yml +++ b/docs/readthedocs/environment.yml @@ -2,7 +2,7 @@ name: readthedocs channels: - conda-forge dependencies: - - python=3.12 + - python=3.9 - gxx_linux-64 - cmake - ninja From 2c72e36100dd2ef00e03c0b1abbdbcce615a84c3 Mon Sep 17 00:00:00 2001 From: selimnairb Date: Tue, 10 Sep 2024 22:57:01 -0400 Subject: [PATCH 20/21] #112: readthedocs: Update conda invocation, attempt 15: revert to latest in master --- docs/readthedocs/environment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/readthedocs/environment.yml b/docs/readthedocs/environment.yml index 868a56c7c9..d269cd5f17 100644 --- a/docs/readthedocs/environment.yml +++ b/docs/readthedocs/environment.yml @@ -11,7 +11,7 @@ dependencies: - swig - catch2 - unittest-xml-reporting - - Sphinx + - Sphinx=6.2.1 - numpydoc - breathe - myst-parser From 8ff5c2d7e860aa4dbe6716ba638f41cdc3b7b8dc Mon Sep 17 00:00:00 2001 From: selimnairb Date: Thu, 12 Sep 2024 09:52:28 -0400 Subject: [PATCH 21/21] #112: FSD: Ensure correct identifiers are used for depth correction and vertical uncertainty code lists --- docs/sphinx/source/fsd/FSD-BAGStructure.md | 26 +++++++++++----------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/sphinx/source/fsd/FSD-BAGStructure.md b/docs/sphinx/source/fsd/FSD-BAGStructure.md index 58b93fe3b3..817b146009 100644 --- a/docs/sphinx/source/fsd/FSD-BAGStructure.md +++ b/docs/sphinx/source/fsd/FSD-BAGStructure.md @@ -56,13 +56,13 @@ The ISO 19115 object model provided most of the needed classes and attributes re | Enumerated Value | Description | | :-------------------- |:----------------------------------------------------------------------------------------------------------------------------------------| -| BAG_VertUncertCode_rawStdDev | "Raw Standard Deviation" - Raw standard deviation of soundings that contributed to the node | -| BAG_VertUncertCode_cubeStdDev | "CUBE Standard Deviation" - Standard deviation of soundings captured by a CUBE hypothesis (i.e., CUBE’s standard output of uncertainty) | -| BAG_VertUncertCode_productUncert | "Product Uncertainty" - NOAA standard product uncertainty V1.0 (a blend of CUBE uncertainty and other measures). | -| BAG_VertUncertCode_noaaProduct_2024 | "Product Uncertainty 2024" - NOAA standard product uncertainty version 2024 (https://repository.library.noaa.gov/view/noaa/61830) | -| BAG_VertUncertCode_historicalStdDev | "Historical Standard Deviation" – Estimated standard deviation based on historical/archive data. | -| BAG_VertUncertCode_averageTPE | "Average TPE" - Average of all of the contributing sounding TPE's within the node. | -| BAG_VertUncertCode_unknown | "Unknown" - The uncertainty layer is an unknown type | +| rawStdDev | "Raw Standard Deviation" - Raw standard deviation of soundings that contributed to the node | +| cubeStdDev | "CUBE Standard Deviation" - Standard deviation of soundings captured by a CUBE hypothesis (i.e., CUBE’s standard output of uncertainty) | +| productUncert | "Product Uncertainty" - NOAA standard product uncertainty V1.0 (a blend of CUBE uncertainty and other measures). | +| noaaProduct_2024 | "Product Uncertainty 2024" - NOAA standard product uncertainty version 2024 (https://repository.library.noaa.gov/view/noaa/61830) | +| historicalStdDev | "Historical Standard Deviation" – Estimated standard deviation based on historical/archive data. | +| averageTPE | "Average TPE" - Average of all of the contributing sounding TPE's within the node. | +| unknown | "Unknown" - The uncertainty layer is an unknown type | Secondly, the `trackingId` extension allows internal Tracking List entries to be associated with a unique entry in the metadata so that the changes can be properly attributed, described and easily referenced. @@ -73,12 +73,12 @@ Thirdly, the `depthCorrectionType` extension was added to allow the BAG file to | Enumerated Value | Description | | :-------------------- | :------------ | -| BAG_DepthCorrectCode_trueDepth | “True Depth” – Depth corrected for sound velocity | -| BAG_DepthCorrectCode_nominalDepthMetre | “Nominal at 1500m/s”- Depth at assumed sound velocity of 1500m/s | -| BAG_DepthCorrectCode_nominalDepthFeet | “Nominal at 4800ft/s” – Depth at assumed sound velocity of 4800ft/s | -| BAG_DepthCorrectCode_correctedCarters | “Corrected via Carter’s Tables” – Corrected depth using Carter’s tables | -| BAG_DepthCorrectCode_correctedMatthews | “Corrected via Matthew’s Tables” – Corrected depth using Matthew’s tables | -| BAG_DepthCorrectCode_unknown | “Unknown” – Unknown depth correction type or mixture of above types | +| trueDepth | “True Depth” – Depth corrected for sound velocity | +| nominalDepthMetre | “Nominal at 1500m/s”- Depth at assumed sound velocity of 1500m/s | +| nominalDepthFeet | “Nominal at 4800ft/s” – Depth at assumed sound velocity of 4800ft/s | +| correctedCarters | “Corrected via Carter’s Tables” – Corrected depth using Carter’s tables | +| correctedMatthews | “Corrected via Matthew’s Tables” – Corrected depth using Matthew’s tables | +| unknown | “Unknown” – Unknown depth correction type or mixture of above types | ### Common Encoding