diff --git a/README.md b/README.md index 341df91..5ddb4e6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ # Orbitdeterminator-Webapp: A webapp for [Orbit Determinator](https://github.com/aerospaceresearch/orbitdeterminator) +[![Build Status](https://travis-ci.org/aerospaceresearch/orbitdeterminator-webapp.svg?branch=master)](https://travis-ci.org/aerospaceresearch/orbitdeterminator-webapp) + ## Quick Start -__orbitdeterminator__ is a package written in python3 for determining orbit of satellites based on positional data. Various filtering and determination algorithms are available for satellite operators to choose from. +__orbitdeterminator__ is a package written in python3 for determining orbit of satellites based on positional data. Various filtering and determination algorithms are available for satellite operators to choose from. This is the webapp for orbitdeterminator. + +### Installation Instructions +Clone the repository and cd into it. +``` +git clone https://github.com/aerospaceresearch/orbitdeterminator-webapp +cd orbitdeterminator-webapp +``` +Install OrbitDeterminator +``` +pip install git+https://github.com/aerospaceresearch/orbitdeterminator +``` +Install other requirements +``` +pip install -r requirements.txt +``` + +### Usage +Run the app with `python app.py`. Go to [http://localhost:8050](http://localhost:8050) to view the app. + +See [here](http://orbit-determinator.readthedocs.io/en/latest/) for OrbitDeterminator documentation. -See [here](http://orbit-determinator.readthedocs.io/en/latest/) for installation instructions and documentation. +![](screenshot.png) diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..864978f Binary files /dev/null and b/screenshot.png differ