Dev

.github/workflows/cff-validator.yml

@@ -0,0 +1,27 @@
+name: Validate CITATION.cff
+
+on:
+  push:
+    paths:
+      - 'CITATION.cff'
+      - '.github/workflows/cff-validator.yml'
+  pull_request:
+    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@v3
+        with:
+          install-r: true

.gitignore

@@ -5,6 +5,10 @@ __pycache__/
 
 # C extensions
 *.so
+*.so.*
+*.dylib
+*.DLL
+*.dll
 
 # Distribution / packaging
 .Python

.pre-commit-config.yaml

@@ -0,0 +1,41 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-ast
+        types: [file, python]
+      - id: check-case-conflict
+      - id: check-docstring-first
+        types: [file, python]
+      - id: check-merge-conflict
+      - id: check-yaml
+        types: [file, yaml]
+      - id: debug-statements
+        types: [file, python]
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.0
+    hooks:
+      - id: pyupgrade
+        args: ["--py39-plus"]
+  - repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+      - id: isort
+        name: isort (python)
+        types: [file, python]
+        args: ["--profile", "black", "--filter-files", "--gitignore"]
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        types: [file, python]
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint
+        types: [file, markdown]
+        exclude: GitHubRepoPublicReleaseApproval.md
+        args: ["--disable", "MD013"]

.zenodo.json

@@ -0,0 +1,43 @@
+{
+    "upload_type": "software",
+    "publication_date": "TODO-TEMPLATE",
+    "title": "Low Frequency / Medium Frequency (LF/MF) Propagation Model, Python Wrapper",
+    "creators": [
+        {
+            "name": "Heroy, Chen",
+            "affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
+            "orcid": "0009-0006-8728-4502"
+        },
+        {
+            "name": "Romaniello, Anthony W.",
+            "affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
+            "orcid": "0000-0001-8437-6504"
+        }
+    ],
+    "description": "This code repository contains a Python wrapper for the NTIA/ITS implementation of the Low Frequency / Medium Frequency (LF/MF) Propagation Model.",
+    "access_right": "open",
+    "keywords": [
+        "propagation",
+        "communications",
+        "antennas",
+        "radio wave propagation"
+    ],
+    "related_identifiers": [
+        {
+            "identifier": "https://github.com/NTIA/LFMF",
+            "relation": "isSupplementTo",
+            "resource_type": "software"
+        },
+        {
+            "identifier": "https://github.com/NTIA/LFMF-test-data",
+            "relation": "isSupplementedBy",
+            "resource_type": "dataset"
+        },
+        {
+            "identifier": "https://ntia.github.io/propagation-library-wiki/models/LFMF/",
+            "relation": "isDocumentedBy",
+            "resource_type": "softwaredocumentation"
+        }
+    ],
+    "version": "1.1.0"
+}

CITATION.cff

@@ -0,0 +1,42 @@
+cff-version: 1.2.0
+title: >-
+  Low Frequency / Medium Frequency (LF/MF) Propagation Model, Python Wrapper
+message: Please cite this software using these metadata.
+type: software
+authors:
+  - family-names: Heroy
+    given-names: Chen
+    affiliation: >-
+      U.S. Department of Commerce, National
+      Telecommunications and Information Administration,
+      Institute for Telecommunication Sciences
+    orcid: 'https://orcid.org/0009-0006-8728-4502'
+    email: [email protected]
+  - family-names: Romaniello
+    given-names: Anthony W.
+    affiliation: >-
+      U.S. Department of Commerce, National
+      Telecommunications and Information Administration,
+      Institute for Telecommunication Sciences
+    orcid: 'https://orcid.org/0000-0001-8437-6504'
+    email: [email protected]
+  - name: >-
+      U.S. Department of Commerce, National
+      Telecommunications and Information Administration,
+      Institute for Telecommunication Sciences
+    address: 325 Broadway
+    city: Boulder
+    country: US
+    post-code: '80305'
+    region: Colorado
+    alias: NTIA/ITS
+    email: [email protected]
+    website: 'https://its.ntia.gov'
+repository-code: 'https://github.com/NTIA/LFMF-python'
+url: 'https://ntia.github.io/propagation-library-wiki/models/LFMF'
+keywords:
+  - its
+  - propagation
+  - lfmf
+  - antennas
+version: 1.1.0