Skip to content

Commit a568286

Browse files
aromanielloNTIAaromanielloNTIA
authored
Merge pull request #1 from NTIA/InitialRelease
Initial release
2 parents c1632d4 + 5810324 commit a568286

File tree

14 files changed

+1197
-2
lines changed

14 files changed

+1197
-2
lines changed

‎.gitignore‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
*.so.*
9+
*.dylib
10+
*.DLL
11+
*.dll
12+
13+
# Distribution / packaging
14+
.Python
15+
build/
16+
develop-eggs/
17+
dist/
18+
downloads/
19+
eggs/
20+
.eggs/
21+
lib/
22+
lib64/
23+
parts/
24+
sdist/
25+
var/
26+
wheels/
27+
share/python-wheels/
28+
*.egg-info/
29+
.installed.cfg
30+
*.egg
31+
MANIFEST
32+
33+
# PyInstaller
34+
# Usually these files are written by a python script from a template
35+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
36+
*.manifest
37+
*.spec
38+
39+
# Installer logs
40+
pip-log.txt
41+
pip-delete-this-directory.txt
42+
43+
# Unit test / coverage reports
44+
htmlcov/
45+
.tox/
46+
.nox/
47+
.coverage
48+
.coverage.*
49+
.cache
50+
nosetests.xml
51+
coverage.xml
52+
*.cover
53+
*.py,cover
54+
.hypothesis/
55+
.pytest_cache/
56+
cover/
57+
58+
# Translations
59+
*.mo
60+
*.pot
61+
62+
# Django stuff:
63+
*.log
64+
local_settings.py
65+
db.sqlite3
66+
db.sqlite3-journal
67+
68+
# Flask stuff:
69+
instance/
70+
.webassets-cache
71+
72+
# Scrapy stuff:
73+
.scrapy
74+
75+
# Sphinx documentation
76+
docs/_build/
77+
78+
# PyBuilder
79+
.pybuilder/
80+
target/
81+
82+
# Jupyter Notebook
83+
.ipynb_checkpoints
84+
85+
# IPython
86+
profile_default/
87+
ipython_config.py
88+
89+
# pyenv
90+
# For a library or package, you might want to ignore these files since the code is
91+
# intended to run in multiple environments; otherwise, check them in:
92+
# .python-version
93+
94+
# pipenv
95+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
96+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
97+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
98+
# install all needed dependencies.
99+
#Pipfile.lock
100+
101+
# poetry
102+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
103+
# This is especially recommended for binary packages to ensure reproducibility, and is more
104+
# commonly ignored for libraries.
105+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
106+
#poetry.lock
107+
108+
# pdm
109+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
110+
#pdm.lock
111+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
112+
# in version control.
113+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
114+
.pdm.toml
115+
.pdm-python
116+
.pdm-build/
117+
118+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
119+
__pypackages__/
120+
121+
# Celery stuff
122+
celerybeat-schedule
123+
celerybeat.pid
124+
125+
# SageMath parsed files
126+
*.sage.py
127+
128+
# Environments
129+
.env
130+
.venv
131+
env/
132+
venv/
133+
ENV/
134+
env.bak/
135+
venv.bak/
136+
137+
# Spyder project settings
138+
.spyderproject
139+
.spyproject
140+
141+
# Rope project settings
142+
.ropeproject
143+
144+
# mkdocs documentation
145+
/site
146+
147+
# mypy
148+
.mypy_cache/
149+
.dmypy.json
150+
dmypy.json
151+
152+
# Pyre type checker
153+
.pyre/
154+
155+
# pytype static type analyzer
156+
.pytype/
157+
158+
# Cython debug symbols
159+
cython_debug/
160+
161+
# PyCharm
162+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
163+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
164+
# and can be added to the global gitignore or merged into this file. For a more nuclear
165+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
166+
#.idea/

‎.pre-commit-config.yaml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v5.0.0
4+
hooks:
5+
- id: check-ast
6+
types: [file, python]
7+
- id: check-case-conflict
8+
- id: check-docstring-first
9+
types: [file, python]
10+
- id: check-merge-conflict
11+
- id: check-yaml
12+
types: [file, yaml]
13+
- id: debug-statements
14+
types: [file, python]
15+
- id: detect-private-key
16+
- id: end-of-file-fixer
17+
- id: trailing-whitespace
18+
- repo: https://github.com/asottile/pyupgrade
19+
rev: v3.19.0
20+
hooks:
21+
- id: pyupgrade
22+
args: ["--py39-plus"]
23+
- repo: https://github.com/pycqa/isort
24+
rev: 5.13.2
25+
hooks:
26+
- id: isort
27+
name: isort (python)
28+
types: [file, python]
29+
args: ["--profile", "black", "--filter-files", "--gitignore"]
30+
- repo: https://github.com/psf/black
31+
rev: 24.10.0
32+
hooks:
33+
- id: black
34+
types: [file, python]
35+
- repo: https://github.com/igorshubovych/markdownlint-cli
36+
rev: v0.42.0
37+
hooks:
38+
- id: markdownlint
39+
types: [file, markdown]
40+
exclude: GitHubRepoPublicReleaseApproval.md
41+
args: ["--disable", "MD013"]

‎.zenodo.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"creators": [
3+
{
4+
"orcid": "TODO-TEMPLATE",
5+
"affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
6+
"name": "TODO-TEMPLATE"
7+
}
8+
],
9+
"license": "NTIA Public Domain",
10+
"title": "TODO-TEMPLATE, Python Wrapper",
11+
"upload_type": "software",
12+
"version": "TODO-TEMPLATE",
13+
"keywords": ["TODO-TEMPLATE"],
14+
"communities": [
15+
{"identifier": "its-proplib"}
16+
]
17+
}

‎CITATION.cff‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
cff-version: 1.2.0
2+
title: >-
3+
Recommendation ITU-R P.2108-1, U.S. Reference Python
4+
Implementation
5+
message: Please cite this software using these metadata.
6+
type: software
7+
authors:
8+
- given-names: William
9+
family-names: Kozma
10+
name-suffix: Jr
11+
email: [email protected]
12+
affiliation: >-
13+
U.S. Department of Commerce, National
14+
Telecommunications and Information Administration,
15+
Institute for Telecommunication Sciences
16+
orcid: 'https://orcid.org/0000-0002-7417-4009'
17+
- given-names: Anthony
18+
family-names: Romaniello
19+
name-particle: W.
20+
email: [email protected]
21+
affiliation: >-
22+
U.S. Department of Commerce, National
23+
Telecommunications and Information Administration,
24+
Institute for Telecommunication Sciences
25+
orcid: 'https://orcid.org/0000-0001-8437-6504'
26+
- name: >-
27+
U.S. Department of Commerce, National
28+
Telecommunications and Information Administration,
29+
Institute for Telecommunications Sciences
30+
address: 325 Broadway
31+
city: Boulder
32+
country: US
33+
post-code: '80305'
34+
region: Colorado
35+
email: [email protected]
36+
website: 'https://its.ntia.gov'
37+
alias: NTIA/ITS
38+
identifiers:
39+
- type: doi
40+
value: 10.5281/zenodo.7114523
41+
description: TODO PLACEHOLDER how was doi generated, doi given is wrong.
42+
repository-code: 'https://github.com/NTIA/p2108-python'
43+
url: 'https://github.com/NTIA/propagation/wiki'
44+
repository: 'https://github.com/NTIA/p2108'
45+
keywords:
46+
- propagation
47+
- rf
48+
- clutter
49+
- itu
50+
license: 'NTIA Public Domain'
51+
version: 1.0.0
52+
date-released: '2024-05-24'

‎CMakeLists.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
###########################################
2+
## COPY COMPILED LIBRARY INTO WRAPPER
3+
###########################################
4+
# This file is expected to be called from a higher-level
5+
# CMakeLists.txt when compiling the C++ library.
6+
7+
# Where to place compiled library for Python wrapper
8+
set(PYTHON_LIB_DIR ${CMAKE_CURRENT_SOURCE_DIR}/src/ITS/ITU/PSeries/${LIB_NAME}/)
9+
10+
add_custom_target(
11+
COPY_LIB_TO_PYTHON ALL
12+
COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:${LIB_NAME}> ${PYTHON_LIB_DIR}
13+
DEPENDS ${LIB_NAME}
14+
COMMENT "Copying library to Python wrapper directory"
15+
)

0 commit comments

Comments
 (0)