From 0e427d9b423285ed5ad43fd4976669d85759ee21 Mon Sep 17 00:00:00 2001 From: cmorgan2018 Date: Mon, 3 May 2021 01:57:30 +0000 Subject: [PATCH] updating readme --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9f6825cd7..f30ed4710 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Analysis Centre Software - POD +# Analysis Centre Software - Ginarn ## Overview @@ -31,15 +31,15 @@ The software is broken into two main components: * the Network Parameter Estimation Algorithm (`PEA-N`); and * the Precise Orbit Determination (`POD`). -## POD +## Software The `ACS` Version 0.0.1 beta release supports: 1. The `POD` -## Directory Structure +### Directory Structure - pod/ + precise_orbit_determination/ ├── LICENSE.md ├── INSTALL.md ├── README.md @@ -50,6 +50,45 @@ The `ACS` Version 0.0.1 beta release supports: ├── tables/ ├── scripts/ +2. The "PEA" +### Directory Structure + parameter_estimation_algorithm/ + ├── LICENSE.md + ├── INSTALL.md + ├── README.md + ├── src/ + ├── bin/ (created) + ├── lib/ (created) + ├── config/ + ├── tables/ + ├── scripts/ + +3. Instructions to use Ginarn: + +First clone this repo: +```git clone https://github.com/GeoscienceAustralia/ginarn``` + +Second initialise the submodules for the PEA and POD +```git submodule update --init --recursive``` + +## Examples + +We have a number of examples on how to run the different components of the software, a quick overview is given in the README.md +For some example see examples on how to use the PEA and POD. + +## Bugs / Issues + +If you find a bug or would like to request a feature please lodge it BUGS + +## Developer Resources + +See this page for some [cheat sheets] and tips for those developing the PEA. + +For notes on the [Algorithms](Link URL) and utilities provided by this repository. + +## Roadmap + +See this page for what we are planning to be working on next.