pystrf/README.md

# Spacecruft pystrf
This is the spacecruft clone of `pystrf`.

Upstream:

* https://gitlab.com/librespacefoundation/pystrf.git

# pystrf
Python based radio frequency satellite tracking.

This is a python port of STRF (https://github.com/cbassa/strf), but will include additional functionality to work with SatNOGS HDF5 artifacts and advanced Doppler curve detection algorithms.

## Installation
Install package dependencies:

```
sudo apt install python3-virtualenv python3-pip python3-tk
```

Optionally, set up python virtual environment:

```
virtualenv -p python3 env
source env/bin/activate
pip install --upgrade pip
```

Install dependencies with
```
pip install -r requirements.txt
```
Install the git large filesystem to download example spectra and run
```
git lfs init
# maybe should be
git lfs install
```
Clone the repository via HTML
```
git clone https://gitlab.com/librespacefoundation/pystrf.git
```
or via SSH (you may have to add SSH keys to your gitlab account)
```
git clone git@gitlab.com:librespacefoundation/pystrf.git
```

## Usage
Enter `virtualenv`, if used:

```
cd pystrf/
source env/bin/activate
```

To view data attached as example:

```
./rfplot.py -p data/2021-08-04T20_48_35 -c tle/satnogs.tle

./rfplot.py -p data/2021-08-04T20_48_35 -c tle/bulk.tle -C 9990
```

![pystrf-bin-example](img/pystrf-2021-08-04T20_48_35.png)
*Example with `data/2021-08-04T20_48_35` files*

Example using SatNOGS observation ID (requires observation uploading h5 artifact):

```
./rfplot.py -p 6282358 -c tle/satnogs.tle
```

![pystrf-observation-example](img/pystrf-obs-6282358.png)
*Observation ID 6282358*

* https://network.satnogs.org/observations/6282358/

# License
Under same license as upstream Libre Space Foundation's repo, AGPL3.