Merge pull request #43 from GeoscienceAustralia/release-v2.1.0

Release v2.1.0
GeoscienceAustralia · Jul 11, 2023 · 9bf0a86 · 9bf0a86
2 parents 488959f + fa4d3bd
commit 9bf0a86
Show file tree

Hide file tree

Showing 326 changed files with 17,957 additions and 99,838 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md → .github/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md → .github/.github/ISSUE_TEMPLATE/bug_report.md
@@ -20,6 +20,9 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
+**Configuration files**
+Yaml files assist with with confirming the exact processing options of the software.
+
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 

diff --git a/.github/.github/workflows_bak/publish.yaml b/.github/.github/workflows_bak/publish.yaml
@@ -0,0 +1,39 @@
+
+name: Documentation
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build-documentation:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Create folders
+      run: |
+        rm Docs/markdown/readme.md
+        cp README.md Docs/markdown/readme.md
+        mkdir -p src/build
+    
+    # Build the HTML documentation
+    - name: Doxygen Action
+      uses: mattnotmitt/[email protected]
+      with:
+          doxyfile-path: ../doc_templates/Doxyfile.in
+          working-directory: ./src/build
+
+    # Deploy the HTML documentation to GitHub Pages
+    - name: GH Pages Deployment
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./Docs/
+        enable_jekyll: false
+        allow_empty_commit: false
+        force_orphan: true
+        publish_branch: gh-pages 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,18 +3,59 @@ 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/),
 
+# [2.1] 2023-07-04
+
+### Added
+Reduced dynamic (Pseudo Stochastic) pulse estimation implemented
+
+Higher(2nd/3rd) order ionosphere modelling
+
+Demonstration of LEO kinematic, reduced dynamic and dynamic orbit estimation
+
+Included pseudo-observation/contrainst to eliminate rank deficiencies in observation models
+
+### Changed
+Complete GNSS constelation attitude modelling implemented (GPS/GAL/GLO/BDS/QZS)
+
+Use case examples updated
+
+Python gnssanalysis tools updates
+
+Improved documentation
+
+Yaml config file updates
+
+### Fixed
+
+### Deprecated
+Ginan version 1 `user` and `network` modes
+
+### Removed
+
+### Security
+
+
 # [2.0.1] 2023-06-09
 ### Added
 ### Changed
 Unified User and Network operation modes (One Observation Model & Filter)
+
 More GNSS constellations – Full Multi-Constellation capability (Ex SBAS)
+
 Better internal frequency indexing (complete Multi-Frequency capability)
+
 UnDifferenced / UnCombined (UDUC) processing (v1 was Combined IF only)
+
 CPP integrated and coupled Precise Orbit Determination (POD) capability
+
 More robust data handling in filter cycle slip and outlier detection and removal
+
 Complete RTCM3 phase 1 and Phase 2 message decoding and encoding
+
 SLR data handling fully implemented
+
 Model & Performance improvements
+
 ### Fixed
 ### Deprecated
 ### Removed

diff --git a/Docs/GinanEDA_AWS_EC2_Instruction_v1.1.txt b/Docs/GinanEDA_AWS_EC2_Instruction_v1.1.txt
diff --git a/Docs/GinanFAQv03.html b/Docs/GinanFAQv03.html
@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="refresh" content="0; url='page.html?p=ginanFAQ.html'" />
+  </head>
+  <body>
+    <p>You will be redirected soon!</p>
+  </body>
+</html> 
diff --git a/Docs/aboutGinan.html b/Docs/aboutGinan.html
@@ -0,0 +1 @@
+redirect.html
diff --git a/Docs/aboutGinan.md b/Docs/aboutGinan.md
@@ -23,17 +23,20 @@ Geoscience Australia will support Ginan with ongoing maintenance and enhancement
 
 Ginan is being rolled out in a phased approach and will offer products in four distinct categories:
 
-1. The software itself. Ginan is open-source software that Geoscience Australia has hosted on this GitHub repository. Anybody who has access to GitHub will be able to download and use the software. Selected parts of the software or the whole application may be downloaded. This is the concept behind Ginan as a toolkit. If a person is only interested in precise orbit determination, they need only take that software. By making the software open-source Geoscience Australia is:
+1. **The software itself.** Ginan is open-source software that Geoscience Australia has hosted on this GitHub repository. Anybody who has access to GitHub will be able to download and use the software. Selected parts of the software or the whole application may be downloaded. This is the concept behind Ginan as a toolkit. If a person is only interested in precise orbit determination, they need only take that software. By making the software open-source Geoscience Australia is:
     1. Supporting GNSS education by allowing students and researchers to examine how the Ginan algorithms work to solve complex problems,
     1. Enabling researchers and commercial organisations to use the software to solve research or commercial problems,
     1. Allowing the software to become more robust over time by giving users the ability to report bugs and make suggestions to improve the software.
-1. Standard precise point positioning (PPP) product files. An operational version of Ginan, maintained by Geoscience Australia, will produce a range of standard PPP product files including, for example, a precise orbits and clocks file in sp3 format. Users with a Geoscience Australia account will be able to log into the Geoscience repository and download the files they require. In time these files will also be submitted to the International GNSS Service (IGS) to become part of their data set.
-1. Precise point positioning correction messages. An operational version of Ginan, maintained by Geoscience Australia, will stream over the internet on a 24 X 7 basis, a range of PPP correction messages in the [RTCM3](https://rtcm.myshopify.com/collections/differential-global-navigation-satellite-dgnss-standards) message format (and later possibly [SPARTN](https://www.spartnformat.org/) and [IGS-SSR](https://www.igs.org/formats-and-standards)) . Users with a Geoscience Australia account will be able to select and connect to the streams they require. The data will enable corrections to be applied in real-time to achieve position accuracies of under 5 cm in equipment capable of consuming the data.
-1. New PPP products and applications yet to be defined. The Ginan toolkit gives Geoscience Australia the ability to offer new PPP products, yet to be defined but which, in collaboration with users, may spawn new applications and commercial opportunities. Within the PPP world there are well established conventions, but these do not need to constrain innovative thought.
+1. **Standard precise point positioning (PPP) product files.** An operational version of Ginan, maintained by Geoscience Australia, will produce a range of standard PPP product files including, for example, a precise orbits and clocks file in sp3 format. Users with a Geoscience Australia account will be able to log into the Geoscience repository and download the files they require. In time these files will also be submitted to the International GNSS Service (IGS) to become part of their data set.
+1. **Precise point positioning correction messages.** An operational version of Ginan, maintained by Geoscience Australia, will stream over the internet on a 24 X 7 basis, a range of PPP correction messages in the [RTCM3](https://rtcm.myshopify.com/collections/differential-global-navigation-satellite-dgnss-standards) message format (and later possibly [SPARTN](https://www.spartnformat.org/) and [IGS-SSR](https://www.igs.org/formats-and-standards)) . Users with a Geoscience Australia account will be able to select and connect to the streams they require. The data will enable corrections to be applied in real-time to achieve position accuracies of under 5 cm in equipment capable of consuming the data.
+1. **New PPP products and applications yet to be defined.** The Ginan toolkit gives Geoscience Australia the ability to offer new PPP products, yet to be defined but which, in collaboration with users, may spawn new applications and commercial opportunities. Within the PPP world there are well established conventions, but these do not need to constrain innovative thought.
 
-## Resources
 
-[![](images/GinanProjectOverviewFrontSlide20210902v01.png) The Ginan project overview presentation from March 2022](resources/GinanProjectOverview20220316v01.pdf)
+## Users and Use Cases
+
+Ginan's users and use cases are summarised in the figure below:
+
+![Ginan's users and use cases](images/UseCasesv04.jpg)
 
 ## Collaborate
 
@@ -43,4 +46,8 @@ Geoscience Australia believes that Ginan is a compelling application to use for
 * Novel data formats or combinations for specific applications,
 * Any other aspects related to PPP technology and operations.
 
-Contact Geoscience Australia via e-mail: [email protected] - Include "Ginan" in the title.
+Contact Geoscience Australia via e-mail: [email protected] - Include "Ginan" in the title.
+
+## Resources
+
+[![](images/GinanProjectOverviewFrontSlide20210902v01.png) The Ginan project overview presentation from March 2022](resources/GinanProjectOverview20220316v01.pdf)