Minor revisions prior to publication

.github/workflows/buildwheels.yml

@@ -0,0 +1,82 @@
+# Action builds a universal (Win32/Win64/macOS-universal/Linux-x64) Python wheel
+# from the source code, using Hatchling, and uploads it as an artifact. This wheel
+# can then be distributed with new releases. The action is triggered by pushes into `main`
+# or pull_requests into `main` or `dev` (for testing). To aid in releases, the workflow is
+# also triggered when new SemVer tags are created. This action handles downloading all
+# shared library files and including them in the resulting wheel.
+name: Build Wheels
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    tags:
+      - 'v[0-9]+.*'
+  pull_request:
+    branches:
+      - main
+      - dev
+
+env:
+    LIBRARY_BASE_REPO: NTIA/p2108
+    LIBRARY_RELEASE_TAG: v1.0-rc.1
+    LIBRARY_DESTINATION_DIRECTORY: 'src/ITS/ITU/PSeries/P2108/'
+
+jobs:
+  build_wheel:
+    name: Build a universal, cross-platform wheel
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      # Only the binaries required for the current platform are downloaded. Note that the distributed
+      # wheel for proplib python packages includes all binaries, so that the wheel is inherently cross-platform.
+      - name: Download required ${{ env.LIBRARY_RELEASE_TAG }} Windows binaries
+        uses: robinraju/release-downloader@v1
+        with:
+          repository: ${{ env.LIBRARY_BASE_REPO }}
+          tag: ${{ env.LIBRARY_RELEASE_TAG }}
+          fileName: '*.dll'
+          tarBall: false
+          zipBall: false
+          out-file-path: ${{ env.LIBRARY_DESTINATION_DIRECTORY }}
+
+      - name: Download required ${{ env.LIBRARY_RELEASE_TAG }} Linux binaries
+        uses: robinraju/release-downloader@v1
+        with:
+          repository: ${{ env.LIBRARY_BASE_REPO }}
+          tag: ${{ env.LIBRARY_RELEASE_TAG }}
+          fileName: '*.so'
+          tarBall: false
+          zipBall: false
+          out-file-path: ${{ env.LIBRARY_DESTINATION_DIRECTORY }}
+
+      - name: Download required ${{ env.LIBRARY_RELEASE_TAG }} macOS binaries
+        uses: robinraju/release-downloader@v1
+        with:
+          repository: ${{ env.LIBRARY_BASE_REPO }}
+          tag: ${{ env.LIBRARY_RELEASE_TAG }}
+          fileName: '*.dylib'
+          tarBall: false
+          zipBall: false
+          out-file-path: ${{ env.LIBRARY_DESTINATION_DIRECTORY }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install build dependencies
+        run: pip install hatchling
+
+      - name: Build wheels
+        run: hatchling build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Universal Wheel (.whl)
+          path: dist/*.whl

.github/workflows/cff-validator.yml

@@ -0,0 +1,27 @@
+name: Validate CITATION.cff
+
+on:
+  push:
+    branches: ["main", "dev"]
+    paths:
+      - 'CITATION.cff'
+      - '.github/workflows/cff-validator.yml'
+  pull_request:
+    branches: ["main", "dev"]
+    paths:
+      - 'CITATION.cff'
+      - '.github/workflows/cff-validator.yml'
+  workflow_dispatch:
+
+jobs:
+  Validate-CITATION-cff:
+    runs-on: ubuntu-latest
+    name: Validate CITATION.cff
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Validate CITATION.cff
+        uses: dieghernan/cff-validator@v4

.github/workflows/pytest.yml

@@ -0,0 +1,93 @@
+name: Test with pytest
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+      - dev
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+env:
+    LIBRARY_BASE_REPO: NTIA/p2108
+    LIBRARY_RELEASE_TAG: v1.0-rc.1
+    LIBRARY_DESTINATION_DIRECTORY: 'src/ITS/ITU/PSeries/P2108/'
+
+jobs:
+  run-all-tests:
+    name: ${{ matrix.platform.os-name }} / Py${{ matrix.py }}
+    runs-on: ${{ matrix.platform.os-runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - os-name: 'Windows (64-bit)'
+            os-runner: 'windows-latest'
+            arch-id: 'x64'
+            release-file-pattern: '*-x64.dll'
+          - os-name: 'Windows (32-bit)'
+            os-runner: 'windows-latest'
+            arch-id: 'x86'
+            release-file-pattern: '*-x86.dll'
+          - os-name: 'macOS (intel/x64)'
+            os-runner: 'macos-13'
+            arch-id: 'x64'
+            release-file-pattern: '*.dylib'
+          - os-name: 'macOS (apple/arm64)'
+            os-runner: 'macos-latest'
+            arch-id: 'arm64'
+            release-file-pattern: '*.dylib'
+          - os-name: 'Linux (Ubuntu)'
+            os-runner: 'ubuntu-latest'
+            arch-id: 'x64'
+            release-file-pattern: '*.so'
+        py:    # Python versions to test on all platforms
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+    steps:
+        - name: Check out repository
+          uses: actions/checkout@v4
+          with:
+            submodules: true
+
+        # Cache key is unique to the combination of runner OS + architecture (matrix.arch-id) + release tag
+        - name: Restore ${{ env.LIBRARY_RELEASE_TAG }} binaries from cache if available
+          id: cache-restore
+          uses: actions/cache@v4
+          with:
+            key: ${{ runner.os }}-${{ matrix.platform.arch-id }}-${{ env.LIBRARY_RELEASE_TAG }}
+            path: ${{ env.LIBRARY_DESTINATION_DIRECTORY}}/${{ matrix.platform.release-file-pattern }}
+
+        # Only the binaries required for the current platform are downloaded. Note that the distributed
+        # wheel for proplib python packages includes all binaries, so that the wheel is inherently cross-platform.
+        - name: Download required ${{ env.LIBRARY_RELEASE_TAG }} binaries
+          if: ${{ steps.cache-restore.outputs.cache-hit != 'true' }}
+          uses: robinraju/release-downloader@v1
+          with:
+            repository: ${{ env.LIBRARY_BASE_REPO }}
+            tag: ${{ env.LIBRARY_RELEASE_TAG }}
+            fileName: ${{ matrix.platform.release-file-pattern }}
+            tarBall: false
+            zipBall: false
+            out-file-path: ${{ env.LIBRARY_DESTINATION_DIRECTORY }}
+
+        - name: Set up Python ${{ matrix.py }}
+          uses: actions/setup-python@v5
+          with:
+            architecture: ${{ matrix.platform.arch-id }}
+            python-version: ${{ matrix.py }}
+            cache: 'pip'
+
+        - name: Install dependencies for testing
+          run: python -m pip install -e .[tests]
+
+        - name: Run pytest
+          run: pytest --cov-report=term-missing --no-cov-on-fail --cov

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tests/data"]
+	path = tests/data
+	url = https://github.com/NTIA/p2108-test-data

.pre-commit-config.yaml

@@ -16,7 +16,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.0
+    rev: v3.19.1
     hooks:
       - id: pyupgrade
         args: ["--py39-plus"]
@@ -33,7 +33,7 @@ repos:
       - id: black
         types: [file, python]
   - repo: https://github.com/igorshubovych/markdownlint-cli
-    rev: v0.42.0
+    rev: v0.43.0
     hooks:
       - id: markdownlint
         types: [file, markdown]

.zenodo.json

@@ -1,17 +1,37 @@
 {
+    "upload_type": "software",
+    "publication_date": "2024-12-11",
+    "title": "Recommendation ITU-R P.2108, Python Wrapper",
     "creators": [
         {
-            "orcid": "TODO-TEMPLATE",
+            "name": "Romaniello, Anthony W.",
             "affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
-            "name": "TODO-TEMPLATE"
+            "orcid": "0000-0001-8437-6504"
         }
     ],
-    "license": "NTIA Public Domain",
-    "title": "TODO-TEMPLATE, Python Wrapper",
-    "upload_type": "software",
-    "version": "TODO-TEMPLATE",
-    "keywords": ["TODO-TEMPLATE"],
-    "communities": [
-        {"identifier": "its-proplib"}
-    ]
+    "description": "This repository contains a Python wrapper for the NTIA/ITS implementation of Recommendation ITU-R P.2108. This Recommendation contains three methods for the prediction of clutter loss: Height Gain Terminal Correction Model, Terrestrial Statistical Model, and Aeronautical Statistical Model. The software implements Section 3 of Annex 1 of the Recommendation. This Python package wraps the NTIA/ITS C++ implementation.",
+    "keywords": [
+        "clutter",
+        "ITU",
+        "ITU-R",
+        "propagation"
+    ],
+    "related_identifiers": [
+        {
+            "identifier": "https://github.com/NTIA/p2108",
+            "relation": "isSupplementTo",
+            "resource_type": "software"
+        },
+        {
+            "identifier": "https://github.com/NTIA/p2108-test-data",
+            "relation": "isSupplementedBy",
+            "resource_type": "dataset"
+        },
+        {
+            "identifier": "https://ntia.github.io/propagation-library-wiki/models/P2108/",
+            "relation": "isDocumentedBy",
+            "resource_type": "softwaredocumentation"
+        }
+    ],
+    "version": "1.0.0"
 }

CITATION.cff

@@ -1,22 +1,11 @@
 cff-version: 1.2.0
 title: >-
-  Recommendation ITU-R P.2108-1, U.S. Reference Python
-  Implementation
+  Recommendation ITU-R P.2108, Python Wrapper
 message: Please cite this software using these metadata.
 type: software
 authors:
-  - given-names: William
-    family-names: Kozma
-    name-suffix: Jr
-    email: wkozma@ntia.gov
-    affiliation: >-
-      U.S. Department of Commerce, National
-      Telecommunications and Information Administration,
-      Institute for Telecommunication Sciences
-    orcid: 'https://orcid.org/0000-0002-7417-4009'
-  - given-names: Anthony
+  - given-names: Anthony W.
     family-names: Romaniello
-    name-particle: W.
     email: aromaniello@ntia.gov
     affiliation: >-
       U.S. Department of Commerce, National
@@ -26,27 +15,20 @@ authors:
   - name: >-
       U.S. Department of Commerce, National
       Telecommunications and Information Administration,
-      Institute for Telecommunications Sciences
+      Institute for Telecommunication Sciences
     address: 325 Broadway
     city: Boulder
     country: US
     post-code: '80305'
     region: Colorado
+    alias: NTIA/ITS
     email: code@ntia.gov
     website: 'https://its.ntia.gov'
-    alias: NTIA/ITS
-identifiers:
-  - type: doi
-    value: 10.5281/zenodo.7114523
-    description: TODO PLACEHOLDER how was doi generated, doi given is wrong.
 repository-code: 'https://github.com/NTIA/p2108-python'
-url: 'https://github.com/NTIA/propagation/wiki'
-repository: 'https://github.com/NTIA/p2108'
+url: 'https://ntia.github.io/propagation-library-wiki/models/P2108/'
 keywords:
   - propagation
   - rf
   - clutter
   - itu
-license: 'NTIA Public Domain'
 version: 1.0.0
-date-released: '2024-05-24'

GitHubRepoPublicReleaseApproval.md

@@ -0,0 +1,32 @@
+# GitHub Repository Public Release Approval
+
+**Project Name:** NTIA/OSM Research and Development
+
+**Software Name:** Recommendation ITU-R P.2108, Python Wrapper
+
+The project identified above, which is contained within the repository this
+document is stored in, has met the following criteria for public release:
+
+1. [ ] The project, including the test criteria, meets the requirements defined
+in the ITS Software Development Publication Policy for making a repository public.
+The major pre-established criteria for publication are listed below, and the check
+mark next to each attests that the criterion has been met.
+    * [ ] Unit tests are available and the software has been tested against the unit tests.
+    * [ ] The software can be compiled and/or used on Windows, macOS, and Linux.
+    * [ ] The repository structure and contents follow from the ITS PropLib template, and
+    all template or placeholder code has been removed.
+    * [ ] The repository includes the appropriate `LICENSE.md` file
+2. [ ] Any test data necessary for the code and its unit tests to function is included in this
+GitHub repository, either directly or as a linked Git submodule.
+3. [ ] The README.md file has passed editorial review from the ITS Publications Office.
+4. [ ] The project complies with the ITS Code Style Guide or an appropriate style
+guide as agreed to by the sponsor, project lead, or Supervising Division Chief.
+5. [ ] Approved disclaimer and licensing language has been included.
+
+In order to complete this approval, please create a new branch, upload and commit
+your version of this Markdown document to that branch, then create a pull request
+for that branch. The following must login to GitHub and approve that pull request
+before the pull request can be merged and this repo made public:
+
+* Project Lead: Brian Lain
+* Supervising Division Chief or Release Authority: Chris Anderson