Merge pull request #85 from GreenBankObservatory/cat-devel-merger

Cat devel merger

.env.template

@@ -0,0 +1,8 @@
+# Template environment file for building the docs
+# Copy this to .env, then edit all indicated lines
+
+# Documentation Settings
+export DOCS_ROOT="path/to/dysh/docs"    # EDIT ME
+export DOCS_HOST=""                     # EDIT ME
+export DOCS_PORT=""                     # EDIT ME
+alias startdocs="cd $DOCS_ROOT && cd source && sphinx-autobuild . _build -b html --host $DOCS_HOST --port $DOCS_PORT"

.github/workflows/build.yml

@@ -28,4 +28,4 @@ jobs:
         pip install -e .
     - name: Build with hatch
       run: |
-        hatch build -c 
+        hatch build -c 

.github/workflows/python-package.yml → .github/workflows/hatch-and-pytest.yml

@@ -1,16 +1,17 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python package
+name: Build and Pytest
 
 on:
   push:
-    branches: [ "main", "release-0.1.0", "cat-devel", "mwp-devel", "pedro-devel" ]
+    branches: [ "main", "release-0.2.0", "cat-devel", "mwp-devel", "pedro-devel" ]
   pull_request:
-    branches: [ "main", "release-0.1.0", "cat-devel", "mwp-devel", "pedro-devel" ]
+    branches: [ "main", "release-0.2.0", "cat-devel", "mwp-devel", "pedro-devel" ]
 jobs:
   build:
     runs-on:  ${{ matrix.os }}
+    environment: hatch build
 
     strategy:
       fail-fast: false
@@ -27,9 +28,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
         pip install -r requirements.txt
         pip install -e .
+    - name: Build with hatch
+      run: |
+        hatch build -c 
     - name: Test with pytest
       run: |
         pytest

.github/workflows/pyinstaller.yml

@@ -0,0 +1,38 @@
+
+name: Package GUI with Pyinstaller
+
+on:
+  push:
+    branches: [ "cat-devel" ]
+  pull_request:
+    branches: [ "cat-devel" ]
+
+jobs:
+  build:
+    runs-on:  ${{ matrix.os }}
+    environment: hatch build
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .
+      - name: Build with hatch
+        run: |
+          hatch build -c 
+      - name: Package GUI with PyInstaller
+        run: |
+          cd gui
+          pyinstaller app.py

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: "3.x"
+        python-version: ["3.x"]
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -23,9 +23,10 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements-dev.txt
+        pip install -r requirements.txt
         pip install -e .
     - name: Build with hatch
+      run: |
         hatch build -c 
 
   pypi-publish:

.gitignore

@@ -1,3 +1,10 @@
+# Custom
+*.fits
+.ignore/
+docs/source/_build/
+gui/build
+gui/dist
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -47,39 +47,50 @@ The usual caveats apply how you set up your python development environment.
     $ pip install hatch
 ```
 
-2.  Create and activate a virtual environment with hatch and install the packages required for development.
+2.  Hatch will default to using the system Python if there's no ``HATCH_PYTHON`` environment variable set. To use a specific version of Python, add the following line to your ``~/.bash_profile``:
+
+```
+export HATCH_PYTHON=/path/to/bin/python
+```
+
+Then source the new profile to apply the changes.
+
+```bash
+$ source ~/.bash_profile
+```
+
+3.  Create and activate a virtual environment with hatch and install the packages required for development. 
 The virtual environment will be created the first time; subsequent invoking ``hatch shell`` will simply load the created environment.cdi
 
 ```bash
     $ hatch shell
-    (dysh) $ pip install -r requirements_dev.txt
+    (dysh) $ pip install -r requirements.txt
 ```
 
-3.  Build and install the package
+4.  Build and install the package
 
 ```bash
     (dysh) $ hatch build
     (dysh) $ pip install -e .
 ```
 
-4.  You can exit this environment (which effectively had started a new shell) just exit:
+5.  You can exit this environment (which effectively had started a new shell) just exit:
 
 ```bash
     (dysh) $ exit
-    $ 
 ```
 
-4.  Each time when you come back in this directory without being in this virtual environment, you'll need to load the virtual environment
+6.  Each time when you come back in this directory without being in this virtual environment, you'll need to load the virtual environment
 
 ```bash
     $ hatch shell
 ```
-    Notice you can ONLY do that from this directory
+
+Notice you can ONLY do that from this directory
 
 ## Testing
  We use pytest for unit and integration testing.  From the top-level dysh directory, run:
 
 ```bash
     $ pytest
 ```
-

docs/source/background/index.rst

@@ -8,4 +8,4 @@ Why does this exist?
    :maxdepth: 2
 
    gbo_context
-   sdfits_files
+   sdfits_files/index

docs/source/background/sdfits_files.rst → docs/source/background/sdfits_files/gbt_sdfits.rst

@@ -1,15 +1,10 @@
-************
-SDFITS Files 
-************
+****************
+GBT SDFITS Files 
+****************
 
-Overview
-========
-The single-dish FITS (SDFITS) convention is used for observer-facing GBT data. The GBT records raw data to FITS files, and then the SDFITS filler populates SDFITS files with information the observer needs. 
-
-GBT Convention
-=================
-
-GBT SDFITS files contain 2 Header-Data Units (HDUs). Note that keys sometimes appear to be truncated because they can only have up to 8 letters. 
+Convention
+==========
+The single-dish FITS (SDFITS) convention is used for observer-facing GBT data. The GBT records raw data to FITS files, and then the SDFITS filler populates SDFITS files with information the observer needs. GBT SDFITS files contain 2 or more Header-Data Units (HDUs). Note that keys sometimes appear to be truncated because they can only have up to 8 letters. 
 
 HDU 0 (PRIMARY)
 ---------------

docs/source/background/sdfits_files/index.rst

@@ -0,0 +1,10 @@
+************
+SDFITS Files
+************
+
+Here are some of the telescopes which use SDFITS files.
+
+.. toctree::
+   :maxdepth: 2
+
+   gbt_sdfits

docs/source/design/index.rst

@@ -7,4 +7,5 @@ Stuff about the overall design
 .. toctree::
    :maxdepth: 2
 
-   sdfits_loaders
+   sdfits_loaders
+   structure

docs/source/design/structure.rst

@@ -0,0 +1,30 @@
+*********
+Structure
+*********
+
+.. mermaid::
+
+    erDiagram
+        SESSION {
+            int session_id PK, FK
+            int obsblock_id FK
+        }
+        OBSBLOCK {
+            int obsblock_id PK, FK
+            int spectrum_id FK
+            int flag
+        }
+        SPECTRUM {
+            int spectrum_id PK, FK
+            int flag
+        }
+        SPECTRUM_DATA {
+            int spectrum_id PK, FK
+            list flags
+            list frequencies
+            list intensities
+        }
+
+        SESSION ||--|{ OBSBLOCK : "has one or more"
+        OBSBLOCK ||--|{ SPECTRUM : "has one or more"
+        SPECTRUM ||--|| SPECTRUM_DATA : "has one"