Merge remote-tracking branch 'proplib-template/main' into InitialRelease

Author: aromanielloNTIA

.pre-commit-config.yaml

@@ -1,5 +1,3 @@
-default_language_version:
-  python: python3.9
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0

.zenodo.json

@@ -0,0 +1,17 @@
+{
+    "creators": [
+        {
+            "orcid": "TODO-TEMPLATE",
+            "affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
+            "name": "TODO-TEMPLATE"
+        }
+    ],
+    "license": "NTIA Public Domain",
+    "title": "TODO-TEMPLATE, Python Wrapper",
+    "upload_type": "software",
+    "version": "TODO-TEMPLATE",
+    "keywords": ["TODO-TEMPLATE"],
+    "communities": [
+        {"identifier": "its-proplib"}
+    ]
+}

README.md

@@ -51,7 +51,7 @@ compiling it yourself from the C++ source code. Either way, ensure that the shar
 (`.dll`, `.dylib`, or `.so` file) is placed in `src/ITS/ITU/PSeries/P2108/`, alongside `__init__.py`.
 
 Below are the steps to build and install the Python package from source, including
-optionally compiling the shared library from the C++ source code. Working installations of Git and
+compiling the library from the C++ source code. Working installations of Git and
 Python (3.9 or above) are required. If compiling the shared library, CMake and a C++ compiler
 are also required.
 

tests/test_p2108.py

@@ -11,6 +11,7 @@
 ABSTOL__DB = 0.1  # Absolute tolerance, in dB, to ensure outputs match expected value
 
 
+# TODO-TEMPLATE: Update CSV reader based on test data CSV structure
 def read_csv_test_data(filename: str):
     with open(TEST_DATA_DIR / filename) as f:
         reader = csv.reader(f)