Skip to content

Commit b1715c9

Browse files
update documentation
1 parent 6e668c1 commit b1715c9

File tree

4 files changed

+11
-13
lines changed

4 files changed

+11
-13
lines changed

examples/example_1.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
# this configuration tells PacketRaven to read several text files containing APRS packets
2-
# and output information on the flight track to the console (per-callsign)
1+
# this configuration tells PacketRaven to perform the following functions:
2+
# 1. read several text files containing APRS packets
3+
# 2. output information to the console
34
#
45
# you can run this configuration with the following: `packetraven examples/example_1.yaml`
56

examples/example_2.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# this configuration tells PacketRaven to perform the following functions:
2-
# 1. read packet information from https://aprs.fi
3-
# 2. filter to specific callsigns
4-
# 3. log messages to a text file at `./example_2.log`
2+
# 1. retrieve packets from https://aprs.fi
3+
# 2. filter by specific callsigns
4+
# 3. output information to the console and to `./example_2.log`
55
#
66
# you can run this configuration with the following: `packetraven examples/example_2.yaml`
77

examples/example_3.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
# - a USB port at `/dev/ttyUSB0`
55
# - a text file at `~/packets.txt`
66
# - a PostGreSQL database at `bpp.umd.edu`
7-
# 2. filter to specific callsigns and constrain to a specific time range
7+
# 2. filter by specific callsigns and constrain to a specific time range
88
# 3. provide CUSF prediction information with the given parameters
99
# 4. output packets to a GeoJSON file at `./example_3.geojson`
10-
# 5. log messages to a text file at `./example_3.log`
10+
# 3. output information to the console and to `./example_3.log`
1111
#
1212
# you can run this configuration with the following: `packetraven examples/example_2.yaml`
1313

examples/example_4.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
# this configuration tells PacketRaven to perform the following functions:
2-
# 1. read packet information from https://aprs.fi
3-
# 2. log messages to a text file at `./example_4.log`
4-
# 3. plot altitude using `matplotlib`
2+
# 1. read several text files containing APRS packets
3+
# 2. output information to the console
4+
# 3. plot altitude with `matplotlib`
55
#
66
# you can run this configuration with the following: `packetraven examples/example_4.yaml`
77

8-
log:
9-
filename: 'example_4.log'
10-
118
packets:
129
text:
1310
locations:

0 commit comments

Comments
 (0)