Release v0.5

.github/dependabot.yml

@@ -0,0 +1,19 @@
+---
+
+version: 2
+updates:
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    versioning-strategy: increase-if-necessary
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - gtrevisan
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - gtrevisan

.github/workflows/docs.yml

@@ -1,7 +1,7 @@
 ---
 
 # Simple workflow for deploying static content to GitHub Pages
-name: Deploy documentation to Pages
+name: Docs
 
 # yamllint disable-line rule:truthy
 on:

.github/workflows/install.yml

@@ -0,0 +1,69 @@
+---
+
+name: Install
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - 'main*'
+      - 'dev*'
+    paths:
+      - "pyproject.toml"
+      - "poetry.lock"
+      - ".pip/*"
+  pull_request:
+    branches:
+      - 'main*'
+      - 'dev*'
+    paths:
+      - "pyproject.toml"
+      - "poetry.lock"
+      - ".pip/*"
+
+
+jobs:
+
+
+  poetry:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      github.event.pull_request.draft == false
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+
+      - name: Print versions
+        run: |
+          python --version
+          poetry --version
+
+      - name: Check lock files
+        run: |
+          poetry lock --no-update
+          bash .pip/lock.sh
+          git diff --exit-code || true
+          poetry check
+
+      - name: Poetry install
+        run: poetry install
+
+      - name: List packages
+        run: |
+          poetry run pip list \
+          | tee pip.log
+          grep disruption.py pip.log
+
+      - name: Test import
+        run: |
+          poetry run python -c "import disruption_py"

.github/workflows/lint.yml

@@ -0,0 +1,130 @@
+---
+
+name: Lint
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - 'main*'
+      - 'dev*'
+  pull_request:
+    branches:
+      - 'main*'
+      - 'dev*'
+
+jobs:
+
+
+  black:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      github.event.pull_request.draft == false
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: Install black
+        run: |
+          grep -oP 'black.*?\ ' .pip/dev.txt \
+          | xargs pip install
+
+      - name: Run black
+        run: |
+          black --version
+          black --check .
+
+
+  pylint:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      github.event.pull_request.draft == false
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: Install requirements
+        run: |
+          pip install -r .pip/main.txt -r .pip/dev.txt -r .pip/lab.txt
+          pip install -e .
+
+      - name: Run pylint
+        run: |
+          pylint --version
+          pylint disruption_py examples tests \
+          --msg-template='{path}:{line}:{column}: |{msg_id} {symbol}| {msg}' \
+          | tee pylint.log \
+          | grep -F '*****'
+
+      - name: Compute statistics
+        run: |
+          cut -s -d '|' -f 2 pylint.log \
+          | sort \
+          | uniq -c \
+          | sort -n \
+          | tee stats.log
+
+      - name: Extract worst offender
+        run: |
+          WORST=$(tail -n1 stats.log | grep -o '[IRCWEF][0-9]*')
+          grep "|$WORST" pylint.log
+
+      - name: Print final summary
+        run: |
+          tail pylint.log \
+          | grep '^Your code has been rated'
+
+
+  shellcheck:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      github.event.pull_request.draft == false
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - name: Install shellcheck
+        run: sudo apt-get install shellcheck
+
+      - name: Run shellcheck
+        run: |
+          shellcheck --version
+          find -type f -not -path '*/.git/*' \
+          | xargs grep -l '^#!/bin/bash' \
+          | while read -r FILE
+          do
+             echo "--> $FILE"
+             shellcheck -x "$FILE"
+          done
+
+
+  yamllint:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      github.event.pull_request.draft == false
+    steps:
+
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install yamllint
+        run: |
+          grep -oP 'yamllint.*?\ ' .pip/dev.txt \
+          | xargs pip install
+
+      - name: Run yamllint
+        run: |
+          yamllint --version
+          find -type f -iname '*.yml' -or -iname '*.yaml' \
+          | while read -r FILE
+          do
+             echo "--> $FILE"
+             yamllint "$FILE"
+          done

.github/workflows/tests.yml

@@ -0,0 +1,148 @@
+---
+
+name: Tests
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches:
+      - 'main*'
+      - 'dev*'
+  pull_request:
+    branches:
+      - 'main*'
+      - 'dev*'
+  workflow_dispatch:
+
+jobs:
+
+
+  pytest:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name == 'push' ||
+      github.event.pull_request.draft == false
+    strategy:
+      fail-fast: false
+      matrix:
+        tokamak:
+          - C-MOD
+          - DIII-D
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Add MDSplus sources
+        env:
+          GPG: http://www.mdsplus.org/dist/mdsplus.gpg.key
+          KEY: /usr/share/keyrings/mdsplus.asc
+          REPO: http://www.mdsplus.org/dist/Ubuntu22/repo
+          APT: /etc/apt/sources.list.d/mdsplus.list
+        run: |
+          curl -fsSL "$GPG" \
+          | sudo tee "$KEY"
+          echo "deb [arch=amd64 signed-by=$KEY] $REPO MDSplus alpha" \
+          | sudo tee "$APT"
+
+      - name: Update sources
+        run: sudo apt-get update
+
+      - name: Install prerequisites
+        run: |
+          sudo apt-get install msodbcsql17 # pre-installed
+          sudo apt-get install tdsodbc unixodbc # freetds
+          sudo apt-get install mdsplus-alpha-python # mdsplus
+
+      - name: Configure MDSplus
+        run: |
+          {
+             echo PYTHONPATH=/usr/local/mdsplus/python
+             echo LD_LIBRARY_PATH=/usr/local/mdsplus/lib
+          } \
+          | tee -a "$GITHUB_ENV"
+
+      - name: Setup SSH key
+        run: |
+          mkdir ~/.ssh
+          echo "${{ secrets.SSH_TUNNEL }}" \
+          | tee ~/.ssh/id_rsa \
+          | sha256sum
+          chmod 600 ~/.ssh/id_rsa
+
+      - name: Setup C-MOD
+        if: ${{ matrix.tokamak == 'C-MOD' }}
+        run: |
+          ssh "${{ secrets.CMOD_USER }}@${{ secrets.CMOD_HOST }}" \
+            -p "${{ secrets.CMOD_PORT }}" \
+            -L 8000:alcdata-archives:8000 \
+            -L 1433:alcdb2:1433 \
+            -o StrictHostKeyChecking=no \
+            -N -v 2> ssh.log &
+          echo "$!" \
+          | tee ssh.pid
+          echo "127.0.0.1 alcdata-archives alcdb2" \
+          | sudo tee -a /etc/hosts
+          echo "${{ secrets.CMOD_LOGIN }}" \
+          | tee ~/logbook.sybase_login \
+          | sha256sum
+          echo DISPY_TOKAMAK=CMOD \
+          | tee -a "$GITHUB_ENV"
+
+      - name: Setup DIII-D
+        if: ${{ matrix.tokamak == 'DIII-D' }}
+        env:
+          TDS: /usr/lib/x86_64-linux-gnu/odbc/libtdsodbc.so
+        run: |
+          ssh "${{ secrets.DIIID_USER }}@${{ secrets.DIIID_HOST }}" \
+            -p "${{ secrets.DIIID_PORT }}" \
+            -L 8000:atlas:8000 \
+            -L 8001:d3drdb:8001 \
+            -o StrictHostKeyChecking=no \
+            -N -v 2> ssh.log &
+          echo "$!" \
+          | tee ssh.pid
+          echo "127.0.0.1 atlas d3drdb" \
+          | sudo tee -a /etc/hosts
+          echo "${{ secrets.DIIID_LOGIN }}" \
+          | tee ~/D3DRDB.sybase_login \
+          | sha256sum
+          echo -e "[FreeTDS]\nDescription = FreeTDS\nDriver = $TDS" \
+          | sudo tee -a /etc/odbcinst.ini
+          echo DISPY_TOKAMAK=D3D \
+          | tee -a "$GITHUB_ENV"
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install requirements
+        run: |
+          pip install -r .pip/main.txt -r .pip/dev.txt
+          pip install -e .
+
+      - name: Check tunnel
+        run: |
+          xargs -a ssh.pid ps -p
+          if ! grep 'Authenticated.*publickey' ssh.log
+          then
+             curl -s ipinfo.io && echo
+             cat -n ssh.log
+             false
+          fi
+
+      - name: Test SQL
+        run: python -O examples/sql.py
+
+      - name: Test MDSplus
+        run: python examples/mdsplus.py
+
+      - name: Test EFIT
+        run: python examples/efit.py
+
+      - name: Run all tests
+        run: pytest -v --durations=0 tests
+
+      - name: Close tunnel
+        run: xargs -a ssh.pid kill -TERM