Skip to content

Commit d143aca

Browse files
aromanielloNTIAaromanielloNTIA
authored
Merge pull request #1 from NTIA/dev
Dev
2 parents d52d4fa + ce0e287 commit d143aca

16 files changed

+1025
-1
lines changed

‎.github/workflows/cff-validator.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Validate CITATION.cff
2+
3+
on:
4+
push:
5+
paths:
6+
- 'CITATION.cff'
7+
- '.github/workflows/cff-validator.yml'
8+
pull_request:
9+
paths:
10+
- 'CITATION.cff'
11+
- '.github/workflows/cff-validator.yml'
12+
workflow_dispatch:
13+
14+
jobs:
15+
Validate-CITATION-cff:
16+
runs-on: ubuntu-latest
17+
name: Validate CITATION.cff
18+
env:
19+
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
20+
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v4
24+
- name: Validate CITATION.cff
25+
uses: dieghernan/cff-validator@v3
26+
with:
27+
install-r: true

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ __pycache__/
55

66
# C extensions
77
*.so
8+
*.so.*
9+
*.dylib
10+
*.DLL
11+
*.dll
812

913
# Distribution / packaging
1014
.Python

‎.pre-commit-config.yaml

+41
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.43.0
37+
hooks:
38+
- id: markdownlint
39+
types: [file, markdown]
40+
exclude: GitHubRepoPublicReleaseApproval.md
41+
args: ["--disable", "MD013"]

‎.zenodo.json

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"upload_type": "software",
3+
"publication_date": "TODO-TEMPLATE",
4+
"title": "Low Frequency / Medium Frequency (LF/MF) Propagation Model, Python Wrapper",
5+
"creators": [
6+
{
7+
"name": "Heroy, Chen",
8+
"affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
9+
"orcid": "0009-0006-8728-4502"
10+
},
11+
{
12+
"name": "Romaniello, Anthony W.",
13+
"affiliation": "U.S. Department of Commerce, National Telecommunications and Information Administration, Institute for Telecommunication Sciences",
14+
"orcid": "0000-0001-8437-6504"
15+
}
16+
],
17+
"description": "This code repository contains a Python wrapper for the NTIA/ITS implementation of the Low Frequency / Medium Frequency (LF/MF) Propagation Model.",
18+
"access_right": "open",
19+
"keywords": [
20+
"propagation",
21+
"communications",
22+
"antennas",
23+
"radio wave propagation"
24+
],
25+
"related_identifiers": [
26+
{
27+
"identifier": "https://github.com/NTIA/LFMF",
28+
"relation": "isSupplementTo",
29+
"resource_type": "software"
30+
},
31+
{
32+
"identifier": "https://github.com/NTIA/LFMF-test-data",
33+
"relation": "isSupplementedBy",
34+
"resource_type": "dataset"
35+
},
36+
{
37+
"identifier": "https://ntia.github.io/propagation-library-wiki/models/LFMF/",
38+
"relation": "isDocumentedBy",
39+
"resource_type": "softwaredocumentation"
40+
}
41+
],
42+
"version": "1.1.0"
43+
}

‎CITATION.cff

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
cff-version: 1.2.0
2+
title: >-
3+
Low Frequency / Medium Frequency (LF/MF) Propagation Model, Python Wrapper
4+
message: Please cite this software using these metadata.
5+
type: software
6+
authors:
7+
- family-names: Heroy
8+
given-names: Chen
9+
affiliation: >-
10+
U.S. Department of Commerce, National
11+
Telecommunications and Information Administration,
12+
Institute for Telecommunication Sciences
13+
orcid: 'https://orcid.org/0009-0006-8728-4502'
14+
email: [email protected]
15+
- family-names: Romaniello
16+
given-names: Anthony W.
17+
affiliation: >-
18+
U.S. Department of Commerce, National
19+
Telecommunications and Information Administration,
20+
Institute for Telecommunication Sciences
21+
orcid: 'https://orcid.org/0000-0001-8437-6504'
22+
email: [email protected]
23+
- name: >-
24+
U.S. Department of Commerce, National
25+
Telecommunications and Information Administration,
26+
Institute for Telecommunication Sciences
27+
address: 325 Broadway
28+
city: Boulder
29+
country: US
30+
post-code: '80305'
31+
region: Colorado
32+
alias: NTIA/ITS
33+
email: [email protected]
34+
website: 'https://its.ntia.gov'
35+
repository-code: 'https://github.com/NTIA/LFMF-python'
36+
url: 'https://ntia.github.io/propagation-library-wiki/models/LFMF'
37+
keywords:
38+
- its
39+
- propagation
40+
- lfmf
41+
- antennas
42+
version: 1.1.0

0 commit comments

Comments
 (0)