Release v3.1.0

GeoscienceAustralia · Sep 2, 2024 · cd6a0af · cd6a0af
1 parent 0f26327
commit cd6a0af
Show file tree

Hide file tree

Showing 501 changed files with 22,509 additions and 86,989 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -26,10 +26,12 @@ Yaml files assist with with confirming the exact processing options of the softw
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
+**Operating environment (please complete the following information):**
 - OS: [e.g. Widows, Linux, Mac + Version]
 - Version of Ginan:
 - Library used (Boost, Eigen, ...)
 
+These may be found in the 'Compilation details' section of the pea's output.
+
 **Additional context**
 Add any other context about the problem here.
diff --git a/.github/workflows_bak/publish.yaml b/.github/workflows_bak/publish.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,13 +3,62 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
+# [3.1] 2024-09-02
+
+### Added
+
+Boxwing model for the albedo
+
+Sisnet (SouthPan) message support
+
+SLR processing capability
+
+PBO Position (.pos) format file output support
+
+Apple silicon (M-chip) support
+
+VMF3 file download python script (get_vmf3.py)
+
+POS file visualisation python script (plot_pos.py)
+
+### Changed
+
+EDA improvements
+
+Improved documentation
+
+Use case examples updated
+
+Frequency dependent GLONASS receiver code bias estimation enabled
+
+Improved missing/bad data handling
+
+Bias rates from .BIA/BSX files parsed and used
+
+Measurment and State error handling sigma_limit thresholds separated
+
+Config file reorganisation (rec_reference_system: moved to receiver_options:)
+
+Clock code handling modified
+
+### Fixed
+
+Many bug fixes
+
+### Deprecated
+
+### Removed
+
+### Security
+
+
 # [3.0] 2024-02-05
 
 ### Added
 IERS 2010 standard tide models implemeted and validated including:
-- Solid Earth (SE) Tide, 
-- SE Pole Tide, 
-- Ocean Tide Loading (OTL) 
+- Solid Earth (SE) Tide,
+- SE Pole Tide,
+- Ocean Tide Loading (OTL)
 - Ocean Pole Tide
 - Atmosphere Tide Loading (ATL)
 
@@ -269,44 +318,44 @@ Ginan v2 uncombined/undifferenced algorithm code framework implemented
 Output listing of all available PEA configuration options implemented with pea -Y option
 
 ### Changed
-PEA Rauch-Tung-Striebel (RTS) smoothing filter algorithm performance improved 
+PEA Rauch-Tung-Striebel (RTS) smoothing filter algorithm performance improved
 
 MongoDash visualisation tool renamed Ginan Exploratory Data Analysis tool (GinanEDA), numerous performance and analytical features added
 
-PEA output to MongoDB performance improvement and additional outputs implemented 
+PEA output to MongoDB performance improvement and additional outputs implemented
 
-PEA TRACE and solution summary (.SUM) file format updates. All output is now time tagged with improved formating for easier reading and searching 
+PEA TRACE and solution summary (.SUM) file format updates. All output is now time tagged with improved formating for easier reading and searching
 
-PEA Kalman Filter performance and stability improvements 
+PEA Kalman Filter performance and stability improvements
 
-Streamlined and improved handling of RTCM input and output data and correction streams 
+Streamlined and improved handling of RTCM input and output data and correction streams
 
-Unification of PEA user mode and network mode filters in the codebase 
+Unification of PEA user mode and network mode filters in the codebase
 
-Updated all Ginan PEA and POD user use-case examples to reflect changes since Ginanv-1.2-Aplha release 
+Updated all Ginan PEA and POD user use-case examples to reflect changes since Ginanv-1.2-Aplha release
 
-Updated all Ginan PEA and POD user use-case examples filenames to better reflect their purpose 
+Updated all Ginan PEA and POD user use-case examples filenames to better reflect their purpose
 
-Updated Ginan use case example downloader, download_examples.py script updated to allow individual data, products and solutions tar balls to be downloaded separately 
+Updated Ginan use case example downloader, download_examples.py script updated to allow individual data, products and solutions tar balls to be downloaded separately
 
-CMake.txt file simplification and build stability improvements 
+CMake.txt file simplification and build stability improvements
 
-New Ginan download, install, and use-case videos completed 
+New Ginan download, install, and use-case videos completed
 
 ### Deprecated
 ### Removed
 ### Fixed
-Missing .SP3 file entries and “0 position” satellite entries bug fixed in the POD 
+Missing .SP3 file entries and “0 position” satellite entries bug fixed in the POD
 
-Improved outlier and cycle slip detection and data downweighing in the PEA Kalman Filter 
+Improved outlier and cycle slip detection and data downweighing in the PEA Kalman Filter
 
-IONEX file output format bug fixes 
+IONEX file output format bug fixes
 
-Numerous new Ginan python utilities added (difftrace, diffsnx, duffutil, merge_sp3, log2snx, etc) 
+Numerous new Ginan python utilities added (difftrace, diffsnx, duffutil, merge_sp3, log2snx, etc)
 
-Default PEA Kalman Filter inverter changed to LDLT 
+Default PEA Kalman Filter inverter changed to LDLT
 
-Miscellaneous bug fixes and performance improvements 
+Miscellaneous bug fixes and performance improvements
 
 ### Security
 

diff --git a/Docs/announcements.md b/Docs/announcements.md
@@ -1,18 +1,22 @@
 
-> **5 Feb 2024** - the Ginan team is pleased to release v3.0.0 of the toolkit.
+> **2 Sept 2024** - the Ginan team is pleased to release v3.1.0 of the toolkit.
 >
 > The improvements delivered by this version include:
 >
-> * Unified User and Network operation modes (One Observation Model & Filter),
-> * Box-wing solar radiation modelling
-> * Increased configurability and streamlining of configuration files
-> * Grid-based model estimation
-> * Full Multi-Constellation capability,
-> * Better internal frequency indexing (complete multi-frequency capability),
-> * UnCombined / UnDifferenced (UDUC) processing
-> * Integrated and coupled Precise Orbit Determination capability (POD),
-> * More robust data handling in the filter for cycle slip and outlier detection and removal,
-> * Complete RTCM3 phase 1 and Phase 2 message decoding and encoding,
-> * Satellite Laser Ranging data handling fully implemented,
-> * Performance improvements,
+> * Boxwing model for the albedo
+> * Sisnet (SouthPan) message support
+> * SLR processing capability
+> * PBO Position (.pos) format file output support
+> * Apple silicon (M-chip) support
+> * VMF3 file download python script (get_vmf3.py)
+> * POS file visualisation python script (plot_pos.py)
+> * EDA improvements
+> * Improved documentation
+> * Use case examples updated
+> * Frequency dependent GLONASS receiver code bias estimation enabled
+> * Improved missing/bad data handling
+> * Bias rates from .BIA/BSX files parsed and used
+> * Measurment and State error handling sigma_limit thresholds separated
+> * Config file reorganisation (rec_reference_system: moved to receiver_options:)
+> * Clock code handling modified
 > * Many bug fixes.
diff --git a/Docs/codingStandard.md b/Docs/codingStandard.md
@@ -217,6 +217,7 @@ void function(
 * For structs or classes, use `CamelCase` with capital start
 * For member variables, use `camelCase` with lowercase start
 * For config parameters, use `lowercase_with_underscores`
+* For architectural documentation, use `__Camel_Case_With_Extra_Underscores__`
 * Use suffixes (`_ptr`, `_arr`, `Map`, `List` etc.) to describe the type of container for complex types.
 * Be sure to provide default values for member variables.
 * Use hierarchical objects where applicable.
@@ -258,27 +259,6 @@ if (acsConfig.some_parameter)
 * Never use `free()`, `malloc()`, or `new` unless it cannot be avoided.
 * Threads create synchronisation issues; they should not be used unless manual synchronisation is never required.
 
-## Testing
-
-* Use `TestStack` objects at top of each function that requires automatic unit testing.
-* Use `TestStack` objects with descriptive strings in loops that wrap functions that require automatic unit testing.
-
-```
-void function()
-{
-    TestStack ts(__FUNCTION__);
-
-    //...
-
-    for (auto& obs : obsList)
-    {
-        TestStack ts(obs.Sat.id());
-
-        //...
-    }
-}
-```
-
 ## Documentation
 
 * Use doxygen style documentation for function and struct headers and parameters

diff --git a/Docs/home.md b/Docs/home.md
@@ -1,6 +1,6 @@
 
 
-![The Positioning Australia Ginan logo](images/GinanLogo273.png)
+![The Positioning Australia Ginan logo](images/GinanLogo273.png) [![Geospatial Excellence Awards 2023/24 - Regional Winner](images/GeospatialRegionalWinnerINDUSTRY.png)](https://geospatialcouncil.org.au/geospatial-excellence-award-winners-act/)
 
 Ginan is an open source toolkit for creating precise point positioning (PPP) analysis products, correction streams and positions. It is being actively developed in a Geoscience Australia Positioning Australia program.
 

diff --git a/Docs/images/GeospatialRegionalWinnerINDUSTRY.png b/Docs/images/GeospatialRegionalWinnerINDUSTRY.png
diff --git a/Docs/images/GinanLogo273-solid-name.png b/Docs/images/GinanLogo273-solid-name.png
diff --git a/Docs/images/GinanLogo273-with-background.png b/Docs/images/GinanLogo273-with-background.png
diff --git a/Docs/images/GinanLogo273.png b/Docs/images/GinanLogo273.png
diff --git a/Docs/images/GinanLogo60-solid-name.png b/Docs/images/GinanLogo60-solid-name.png
diff --git a/Docs/images/GinanLogo60-with-background.png b/Docs/images/GinanLogo60-with-background.png
diff --git a/Docs/images/GinanLogo60.png b/Docs/images/GinanLogo60.png
diff --git a/Docs/images/GinanLogo819-solid-name.png b/Docs/images/GinanLogo819-solid-name.png
diff --git a/Docs/images/GinanLogo819-with-background.png b/Docs/images/GinanLogo819-with-background.png
diff --git a/Docs/images/GinanLogo819.png b/Docs/images/GinanLogo819.png
diff --git a/Docs/images/GinanLogo91-solid-name.png b/Docs/images/GinanLogo91-solid-name.png
diff --git a/Docs/images/GinanLogo91-with-background.png b/Docs/images/GinanLogo91-with-background.png
diff --git a/Docs/images/GinanLogo91.png b/Docs/images/GinanLogo91.png
diff --git a/Docs/images/GinanWorkshop1.png b/Docs/images/GinanWorkshop1.png
diff --git a/Docs/images/GinanWorkshop2.png b/Docs/images/GinanWorkshop2.png
diff --git a/Docs/images/GinanWorkshopD.png b/Docs/images/GinanWorkshopD.png
diff --git a/Docs/images/GinanWorkshopS.png b/Docs/images/GinanWorkshopS.png
diff --git a/Docs/images/ginan-bom-case-study.png b/Docs/images/ginan-bom-case-study.png
diff --git a/Docs/images/ginan-csiro-case-study.png b/Docs/images/ginan-csiro-case-study.png
diff --git a/Docs/resources.md b/Docs/resources.md
@@ -4,6 +4,19 @@
 ![A library of information](images/LibraryBooksStrip.png)
 
 
+***
+
+## Ginan Workshop Tutorial - IGNSS 2024 
+
+> [![](images/GinanWorkshopS.png) Slides from the Ginan Workshop hosted at the IGNSS 2024 conference.](resources/Ginan_Workshop_Slides_-_IGNSS_2024.pdf)
+
+> [![](images/GinanWorkshop1.png) Set Up Guide for the Ginan Workshop.](resources/Ginan_Workshop_1_Set-up_Guide_-_IGNSS_2024_-_6_Feb.pdf)
+
+> [![](images/GinanWorkshop2.png) Guide outlining how to run Ginan in the Workshop Tutorial.](resources/Ginan_Workshop_2_Running_Ginan_-_IGNSS_2024_-_6_Feb.pdf)
+
+> [![](images/GinanWorkshopD.png) Guide for those using Docker to run Ginan.](resources/Ginan_Workshop_Docker_Guide_-_IGNSS_2024_-_6_Feb.pdf)
+
+
 ***
 
 ## Ginan presentations
@@ -17,15 +30,20 @@
 
 ## Ginan user stories
 
-> [![](images/AIMSThumb.png) A demonstration showing Ginan on air and sea drones at AIMS Reefworks. August 2023.](resources/GinanAIMSCaseStudy.pdf)
 
-> [![](images/Locate23_S_McClusky_frontpage101X57.jpg) Open-source Precise Point Positioning (PPP) with Ginan v2 - Simon McClusky, from Locate 23, 11 May 2023.](resources/Locate23_S_McClusky_final.pdf)
+> [![](images/ginan-csiro-case-study.png) Report on using Ginan to measure the water level of Googong dam. <br>Partners: CSIRO, FroniterSI<br>August 2024](https://ecat.ga.gov.au/geonetwork/srv/eng/catalog.search#/metadata/149667)
+
+> [![](images/ginan-bom-case-study.png) Report on the results of taking "Ginan-in-a-box" to the edge of space on a weather balloon. <br>Partners: Bureau of Metereology, FroniterSI<br>June 2024](https://ecat.ga.gov.au/geonetwork/srv/eng/catalog.search#/metadata/149656)
+
+> [![](images/AIMSThumb.png) Report on a demonstration showing Ginan on air and sea drones at AIMS Reefworks. <br>Partners: Australian Institute of Marine Science, FrontierSI<br>August 2023](https://ecat.ga.gov.au/geonetwork/srv/eng/catalog.search#/metadata/148622)
+
+> [![](images/Locate23_S_McClusky_frontpage101X57.jpg) Open-source Precise Point Positioning (PPP) with Ginan v2 - Simon McClusky, from Locate 23<br>11 May 2023](resources/Locate23_S_McClusky_final.pdf)
 
-> [![](images/McClusky202301FrontPage101X57.jpg) Australian perspectives on the use of GNSS for tsunami warning - Simon McClusky, Adrienne Moseley, Phil Cummins, Shin-Chan Han, John Dawson, from February 2023.](resources/TourDelIGS5_04_McClusky.pdf)
+> [![](images/McClusky202301FrontPage101X57.jpg) Australian perspectives on the use of GNSS for tsunami warning - Simon McClusky, Adrienne Moseley, Phil Cummins, Shin-Chan Han, John Dawson, <br>Partners: University of Newcastle<br>February 2023](resources/TourDelIGS5_04_McClusky.pdf)
 
-> [![](images/TamDaoIonoPaperFrontPage101X57.jpg) Modelling of Ionospheric Corrections for High Accuracy GNSS Positioning using the GINAN toolkit - Tam Dao, from December 2022.](resources/TamDaoIonosphere.pdf)
+> [![](images/TamDaoIonoPaperFrontPage101X57.jpg) Modelling of Ionospheric Corrections for High Accuracy GNSS Positioning using the GINAN toolkit - Tam Dao, Ken Harima, Brett Carter, Julie Currie, Simon McClusky, Rupert Brown, Eldar Rubinov, John Barassi, Suelynn Choy <br>Partners: RMIT, FrontierSI<br>December 2022](resources/TamDaoIonosphere.pdf)
 
-> [![](images/IonosphereFrontPage101X69.jpg) Using Ginan to analyse the ionosphere from December 2022.](resources/GinanIonosphere20221218v05.pdf)
+> [![](images/IonosphereFrontPage101X69.jpg) Using Ginan to analyse the ionosphere <br>December 2022](resources/GinanIonosphere20221218v05.pdf)
 
 
 ***

diff --git a/Docs/resources/GinanAIMSCaseStudy.pdf b/Docs/resources/GinanAIMSCaseStudy.pdf
diff --git a/Docs/resources/Ginan_Workshop_1_Set-up_Guide_-_IGNSS_2024_-_6_Feb.pdf b/Docs/resources/Ginan_Workshop_1_Set-up_Guide_-_IGNSS_2024_-_6_Feb.pdf
diff --git a/Docs/resources/Ginan_Workshop_2_Running_Ginan_-_IGNSS_2024_-_6_Feb.pdf b/Docs/resources/Ginan_Workshop_2_Running_Ginan_-_IGNSS_2024_-_6_Feb.pdf
diff --git a/Docs/resources/Ginan_Workshop_Docker_Guide_-_IGNSS_2024_-_6_Feb.pdf b/Docs/resources/Ginan_Workshop_Docker_Guide_-_IGNSS_2024_-_6_Feb.pdf
diff --git a/Docs/resources/Ginan_Workshop_Slides_-_IGNSS_2024.pdf b/Docs/resources/Ginan_Workshop_Slides_-_IGNSS_2024.pdf