Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cmorgan2019 committed May 3, 2021
1 parent 02cdd72 commit 0e427d9
Showing 1 changed file with 43 additions and 4 deletions.
47 changes: 43 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Analysis Centre Software - POD
# Analysis Centre Software - Ginarn

## Overview

Expand Down Expand Up @@ -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
Expand All @@ -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.

0 comments on commit 0e427d9

Please sign in to comment.