doc example

main 0.5
Jeff Moe 2022-05-11 23:06:33 -06:00
parent 975a9b59e5
commit a811810007
1 changed files with 54 additions and 45 deletions

View File

@ -1,46 +1,6 @@
# gnss-earth
Spacecruft GNSS Earth is a web application to render GNSS satellites on a globe of Earth (here).
# Installation
Install thusly:
```
sudo apt update
sudo apt install python3-pip
git clone https://spacecruft.org/spacecruft/gnss-earth
cd gnss-earth/
# Install python setup to your taste...
# Update pip...
pip3 install --user --upgrade pip
pip3 install --user --upgrade -r requirements.txt
```
Need to get `cesium.key` from Cesium ION.
There are sample Apache configs in the `apache/` directory.
There are systemd files with really bad PATHs in `systemd`.
Copy them here: `/etc/systemd/system/`
Run: `sudo systemctl daemon-reload`
Then run `systemctl start spacecruft-beidou` or whatever service
you want to start.
You can see what ports it is listening on (from `net-tools` package) ala:
`netstat -pant | grep py`
# Scripts
The following scripts are available for websites:
* `gnss-earth.py` --- All satellites
* `beidou-earth.py` --- Beidou (China) satellites
* `galileo-earth.py` --- Galileo (Europe) satellites
* `glonass-earth.py` --- GLONASS (Russia) satellites
* `gps-earth.py` --- GPS (USA) satellites
# Spacecruft GNSS Earth
Spacecruft GNSS Earth is a series of web applications that render
GNSS satellites on a globe of Earth (here).
# Websites
@ -62,6 +22,55 @@ Websites available for viewing.
* https://gnss.spacecruft.org/
# Scripts
The following scripts are available for running websites:
* `gnss-earth.py` --- All satellites
* `beidou-earth.py` --- Beidou (China) satellites
* `galileo-earth.py` --- Galileo (Europe) satellites
* `glonass-earth.py` --- GLONASS (Russia) satellites
* `gps-earth.py` --- GPS (USA) satellites
# Installation
To install on your own machine:
```
sudo apt update
sudo apt install python3-pip
git clone https://spacecruft.org/spacecruft/gnss-earth
cd gnss-earth/
# Install python setup to your taste...
# Update pip...
pip3 install --user --upgrade pip
pip3 install --user --upgrade -r requirements.txt
```
Need to get `cesium.key` from Cesium ION.
Run the app, such as: `python3 beidou-earth.py`
Then you can view it in a web browser. Each script has it's own port.
URL will be like http://127.0.0.1:8051
If you want a more semi-permanent install with a web proxy that starts on
boot, see you can do below:
There are sample Apache configs in the `apache/` directory.
There are systemd files with really bad PATHs in the `systemd/` directory.
Copy them here: `/etc/systemd/system/`
Run: `sudo systemctl daemon-reload`
Then run `systemctl start spacecruft-beidou` or whatever service
you want to start.
You can see what ports it is listening on (from `net-tools` package) ala:
`netstat -pant | grep py`
# Upstream Dependencies
Uses:
@ -70,8 +79,8 @@ Uses:
* https://github.com/cassova/satellite-czml
* https://celestrak.com/NORAD/elements/
# License / Copyright
Copyright (C) 2022 Jeff Moe
Copyright (C) 2022 Jeff Moe.
License: AGPLv3 or any later version.