From e5aa70664cfef790705ddcb40846a842bb87b3ce Mon Sep 17 00:00:00 2001
From: Bruce Flynn <brucef@ssec.wisc.edu>
Date: Tue, 27 Jun 2017 09:33:13 -0500
Subject: [PATCH] tweaks to README
---
README.md | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index b9beb1b..1dfc103 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,22 @@
-# EdosL0Util (BETA)
-Tools for mangling EDOS L0 PDS files.
+# EdosL0Util
+Tools for mangling EDOS L0 PDS files. This package was primarily written to
+support work with EDOS L0 PDS files but can more generically be considered a
+CCSDS packet file manipulation toolkit.
### Features:
* API for streaming packets
* CLI tools for:
- merging multiple PDS files
- - splitting pds into X minute files
+ - splitting PDS into X minute files
- truncating files to specified time range
- inspecting PDS info
* Dumping JPSS H5 RDRs to L0 PDS files for VIIRS, CrIS, and ATMS
+* Supports both Python 2 & 3
+* Etc ...
There is also support for creating a packet stream from Aqua L0 PDS files, but
-it has not been tested much. Most functionallity assumes EDOS L0 PDS files.
+it has not been tested much. Most functionality assumes EDOS L0 PDS files.
### Packet streaming
@@ -20,7 +24,7 @@ To obtain a simple stream of packets, with support for secondary header
parsing use the ``PacketStream`` class as an iterator.
>>> from edosl0util.stream import PacketStream
- >>> stream = PacketStream(open('P1570826VIIRSSCIENCEAS15286023813501.PDS'))
+ >>> stream = PacketStream(open('P1570826VIIRSSCIENCEAS15286023813501.PDS', 'rb'))
>>> stream.next()
<Packet apid=826 seqid=13072 stamp=2015-10-13 00:22:04.042798>
>>> packets = list(stream)
@@ -89,20 +93,20 @@ The ``rdr2l0`` tool will dump out an RDR in an order not suitable for use as a
NASA L0 PDS file. To generate a L0 PDS file actually requires 2 steps:
```
$> rdr2l0 --diary --skipfill RNSCA-RVIRS_npp_d20151018_t2359214_e0000467_b20595_c20151019015559980487_noaa_ops.h5
-$> edosl0merge -o out.pds RNSCA-RVIRS_npp_d20151018_t2359214_e0000467_b20595_c20151019015559980487_noaa_ops.h5.science.pds
+$> edosl0merge -o out.PDS RNSCA-RVIRS_npp_d20151018_t2359214_e0000467_b20595_c20151019015559980487_noaa_ops.h5.science.PDS
```
-The resulting file ``out.pds`` will have packets sorted by time and apid with
+The resulting file ``out.PDS`` will have packets sorted by time and APID with
any duplicates removed.
-The typical case would be to dump multiple RDR files to pds then merge the
+The typical case would be to dump multiple RDR files to PDS then merge the
resulting PDS files into a 6 minute granule like so:
```
$> rdr2l0 --diary --skipfill RNSCA-RVIRS_npp_d20151018_t000*.h5
-$> edosl0merge -o out.pds --trunc_to "2015-10-18 00:00:00,2015-10-18 00:06:00" *.science.pds
+$> edosl0merge -o out.PDS --trunc_to "2015-10-18 00:00:00,2015-10-18 00:06:00" *.science.PDS
```
Which will create a proper 6 minute NASA L0 PDS file with any fill packets
filtered out.
-If you have quesions or comments related to this software contac
+If you have quesions or comments related to this software contact
brucef@ssec.wisc.edu.
--
GitLab