Merge branch 'pietern:main' into master

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  "Ubuntu":
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - "16.04"
+          - "18.04"
+          - "20.04"
+          - "21.04"
+          - "21.10"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - run: docker build --tag build:ubuntu-${{ matrix.version }} --build-arg version=${{ matrix.version }} docker/ubuntu
+        name: "docker build"
+      - run: docker run --detach --interactive --name build --volume $PWD:/goestools build:ubuntu-${{ matrix.version }}
+        name: "docker run"
+      - run: docker exec -t build /run_cmake.sh
+        name: "cmake"
+      - run: docker exec -t build /run_compile.sh
+        name: "make"

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Documentation
+
+on:
+  push:
+    paths:
+      - 'docs/**'
+    branches:
+      - main
+  pull_request:
+    paths:
+      - 'docs/**'
+    branches:
+      - main
+
+jobs:
+  "Build":
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          cache: 'pip'
+      - run: pip install -r docs/requirements.txt
+      - run: make html
+        working-directory: docs
+      - uses: actions/upload-artifact@v2
+        with:
+          path: docs/_build/html
+
+  "Deploy":
+    needs: "Build"
+    if: success() && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          ref: refs/heads/gh-pages
+      # Remove all tracked files such that we're left with a snapshot of the artifact.
+      - name: clean
+        run: git ls-files -z | xargs -0 rm -f
+      - uses: actions/download-artifact@v2
+      - name: commit
+        run: |
+          rsync -a artifact/ .
+          rm -rf artifact
+          git add -A
+          git config user.name 'github-actions[bot]'
+          git config user.email 'github-actions[bot]@users.noreply.github.com'
+          git commit --allow-empty -m "Snapshot of $GITHUB_SHA"
+      - name: push
+        run: git push origin gh-pages

CMakeLists.txt

@@ -32,8 +32,14 @@ if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "^arm")
   endif()
 endif()
 
-set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/vendor/sanitizers-cmake/cmake ${CMAKE_MODULE_PATH})
-find_package(Sanitizers)
+if(SANITIZE_ADDRESS OR SANITIZE_MEMORY OR
+    SANITIZE_THREAD OR SANITIZE_UNDEFINED)
+  set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/vendor/sanitizers-cmake/cmake ${CMAKE_MODULE_PATH})
+  find_package(Sanitizers)
+else()
+  function(add_sanitizers)
+  endfunction()
+endif()
 
 # Force static build of libaec
 set(BUILD_SHARED_LIBS OFF CACHE INTERNAL "" FORCE)

README.md

@@ -173,13 +173,14 @@ convert -loop 0 -delay 50 *.png GOES15_FD_VS_20170821.gif
 
 ## Resources
 
-All PDFs at http://www.noaasis.noaa.gov/LRIT/pdf-files/ are useful, in
-particular the receiver specs, transmitter specs, and mission data
-documents.
-
-* http://www.noaasis.noaa.gov/LRIT/pdf-files/3_LRIT_Receiver-specs.pdf
-* http://www.noaasis.noaa.gov/LRIT/pdf-files/4_LRIT_Transmitter-specs.pdf
-* http://www.noaasis.noaa.gov/LRIT/pdf-files/5_LRIT_Mission-data.pdf
+Because HRIT is similar to LRIT at a higher baud rate, documentation for
+LRIT is also relevant for HRIT. The documents below used to be hosted
+by NOAA until ~2020. They're mirrored here for posterity (thanks @gojimmypi;
+see https://github.com/pietern/goestools/pull/102).
+
+* [LRIT Receiver Specification](./docs/files/3_LRIT_Receiver-specs.pdf)
+* [LRIT Transmitter Specification](./docs/files/4_LRIT_Transmitter-specs.pdf)
+* [LRIT Mission Specific Data](./docs/files/5_LRIT_Mission-data.pdf)
 
 Also, these blog series:
 

docker/ubuntu/Dockerfile

@@ -0,0 +1,19 @@
+ARG version
+FROM ubuntu:${version}
+
+ARG DEBIAN_FRONTEND=noninteractive
+ENV TZ=UTC
+
+RUN apt-get update && apt-get install -y \
+  build-essential \
+  cmake \
+  git-core \
+  libairspy-dev \
+  libopencv-dev \
+  libproj-dev \
+  librtlsdr-dev \
+  zlib1g-dev \
+  && rm -rf /var/lib/apt/lists/*
+
+COPY ./run_cmake.sh /
+COPY ./run_compile.sh /

docker/ubuntu/run_cmake.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -e
+
+mkdir -p /tmp/goestools
+cd /tmp/goestools
+cmake /goestools

docker/ubuntu/run_compile.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -e
+
+cd /tmp/goestools
+make -j $(nproc)

docs/conf.py

@@ -6,6 +6,8 @@
 # full list see the documentation:
 # http://www.sphinx-doc.org/en/stable/config
 
+import sphinx_rtd_theme
+
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -77,6 +79,7 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/requirements.txt

@@ -2,4 +2,6 @@ sphinx
 sphinx-autobuild
 sphinx_rtd_theme
 pygments-github-lexers
-hg+https://bitbucket.org/birkenfeld/sphinx-contrib#subdirectory=googleanalytics
+# Note: this refers to a fork because upstream is not compatible with newer Sphinx versions.
+# See https://github.com/sphinx-contrib/googleanalytics/pull/1.
+git+https://github.com/jelmer/googleanalytics@983680d

docs/resources.rst

@@ -16,15 +16,13 @@ About the satellites and the signals (GOES-R series):
   * https://www.goes-r.gov/users/grb.html
   * https://www.goes-r.gov/users/docs/GRB_downlink.pdf
 
-Since HRIT is a higher baud rate LRIT, all the docs about the LRIT
-signal and file format still apply:
-
-* http://www.noaasis.noaa.gov/LRIT/pdf-files/3_LRIT_Receiver-specs.pdf
-* http://www.noaasis.noaa.gov/LRIT/pdf-files/4_LRIT_Transmitter-specs.pdf
-* http://www.noaasis.noaa.gov/LRIT/pdf-files/5_LRIT_Mission-data.pdf
-* All PDFs at http://www.noaasis.noaa.gov/LRIT/pdf-files/ are useful,
-  in particular the receiver specs, transmitter specs, and mission
-  data documents.
+Because HRIT is similar to LRIT at a higher baud rate, documentation for
+LRIT is also relevant for HRIT. The documents below used to be hosted
+by NOAA until ~2020. They're mirrored here for posterity.
+
+* :download:`3_LRIT_Receiver-specs.pdf <files/3_LRIT_Receiver-specs.pdf>`
+* :download:`4_LRIT_Transmitter-specs.pdf <files/4_LRIT_Transmitter-specs.pdf>`
+* :download:`5_LRIT_Mission-data.pdf <files/5_LRIT_Mission-data.pdf>`
 
 The blog series by Lucas Teske is a great resource:
 

etc/goesproc.conf

@@ -12,22 +12,22 @@
 # It can be used more than once if needed.
 [[handler]]
 type = "image"
-product = "goes16"
+origin = "goes16"
 region = "m1"
 dir = "./goes16/m1/{time:%Y-%m-%d}"
 
 # GOES-16 full disk originals.
 [[handler]]
 type = "image"
-product = "goes16"
+origin = "goes16"
 region = "fd"
 dir = "./goes16/fd/{time:%Y-%m-%d}"
 
 # GOES-16 full disk, channel 2, with contrast curve applied.
 # The section [handler.remap] below applies to this handler.
 [[handler]]
 type = "image"
-product = "goes16"
+origin = "goes16"
 region = "fd"
 channels = [ "ch02" ]
 directory = "./goes16/fd/{time:%Y-%m-%d}"
@@ -43,7 +43,7 @@ filename = "{filename}_contrast"
 # The sections [handler.remap] and [handler.lut] below apply to this handler.
 [[handler]]
 type = "image"
-product = "goes16"
+origin = "goes16"
 region = "fd"
 channels = [ "ch02", "ch13" ]
 directory = "./goes16/false-color/fd/{time:%Y-%m-%d}"
@@ -60,7 +60,7 @@ directory = "./goes16/false-color/fd/{time:%Y-%m-%d}"
 # identical crops regardless of alignment.
 [[handler]]
 type = "image"
-product = "goes15"
+origin = "goes15"
 region = "fd"
 crop = [ -2373, 2371, -1357, 1347 ]
 directory = "./goes15/fd/{time:%Y-%m-%d}"
@@ -92,7 +92,7 @@ directory = "./emwin/{time:%Y-%m-%d}"
 #
 [[handler]]
 type = "text"
-product = "nws"
+origin = "nws"
 directory = "./nws/{time:%Y-%m-%d}"
 filename = "{time:%Y%m%dT%H%M%SZ}_{awips:nnn}{awips:xxx}"
 
@@ -108,13 +108,13 @@ filename = "{time:%Y%m%dT%H%M%SZ}_{awips:nnn}{awips:xxx}"
 #
 [[handler]]
 type = "image"
-product = "nws"
+origin = "nws"
 directory = "./nws/{time:%Y-%m-%d}"
 filename = "{time:%Y%m%dT%H%M%SZ}_{filename}"
 
 # Miscellaneous text.
 [[handler]]
 type = "text"
-product = "other"
+origin = "other"
 directory = "./text/{time:%Y-%m-%d}"
 filename = "{time:%Y%m%dT%H%M%SZ}_{filename}"