Skip to content

Commit 349d994

Browse files
committed
update README
1 parent fd371a4 commit 349d994

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

+20-18
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,17 @@
55
- The first badge links to the PropLib Wiki and does not need to be edited
66
- The second badge automatically displays and links to the most recent GitHub Release.
77
- Make sure to update the [gh-releases-badge] and [gh-releases-link] URLs with your repo name
8-
- The third badge links to the zenodo DOI page. Only include this badge if a DOI exists for a release.
9-
- Update the [doi-link] using the "id" from https://api.github.com/repos/ntia/{repo_name}. For example, the
10-
[doi-link] for ITM would be https://zenodo.org/badge/latestdoi/218981682. Using the repository ID in this link
11-
will automatically make the link always point to the most recent DOI for the repository, so this won't need to be
12-
edited every time a new release is made.
13-
- Update the [doi-badge] to include the "all versions" DOI which always points to the latest version. This can be found
14-
when creating the DOI in zenodo. The slash in the DOI must be replaced with "%2F" to render in the badge. For example,
15-
the P2108 DOI is 10.5281/zenodo.7114033 which must be input as "10.5281%2Fzenodo.7114033"
16-
- The fourth badge is the CMake/CTest GitHub actions status.
8+
- The third badge is the CMake/CTest GitHub actions status.
179
- Update the repository name in [gh-actions-test-badge] and [gh-actions-test-link]
18-
- The fifth badge is the Doxygen github actions status.
10+
- The fourth badge is the Doxygen github actions status.
1911
- Update the repository name in [gh-actions-docs-badge]
2012
- Update the repository name in [gh-pages-docs-link]
21-
- The sixth badge displays open GitHub Issues
13+
- The fifth badge displays open GitHub Issues
2214
- Update the repository name in [gh-issues-badge]
2315
- Update the repository name in [gh-issues-link]
2416
-->
2517
[![NTIA/ITS PropLib][proplib-badge]][proplib-link]
2618
[![GitHub Release][gh-releases-badge]][gh-releases-link]
27-
[![DOI][doi-badge]][doi-link]
2819
[![GitHub Actions Unit Test Status][gh-actions-test-badge]][gh-actions-test-link]
2920
[![C++ API Reference][gh-actions-docs-badge]][gh-pages-docs-link]
3021
[![GitHub Issues][gh-issues-badge]][gh-issues-link]
@@ -39,19 +30,28 @@
3930
[gh-releases-link]: https://github.com/NTIA/LFMF/releases
4031
[gh-issues-badge]: https://img.shields.io/github/issues/NTIA/LFMF?logo=github&label=Issues&labelColor=162E51
4132
[gh-issues-link]: https://github.com/NTIA/LFMF/issues
42-
[doi-badge]: https://img.shields.io/badge/{TODO-ALL-VERSIONS-DOI}-x?logo=doi&logoColor=ffffff&labelColor=162E51&color=D63E04
43-
[doi-link]: https://zenodo.org/badge/latestdoi/{TODO-REPOSITORY-ID}
4433

4534
This code repository contains the U.S. Reference Software Implementation of
4635
Low Frequency / Medium Frequency (LF/MF) Propagation Model.
4736

37+
Additional bindings to the shared library built from this repository are provided
38+
for .NET, MATLAB, and Python in the following repositories:
39+
40+
- [NTIA/LFMF-dotnet](https://github.com/NTIA/LFMF-dotnet)
41+
- [NTIA/LFMF-matlab](https://github.com/NTIA/LFMF-matlab)
42+
- [NTIA/LFMF-python](https://github.com/NTIA/LFMF-python)
43+
4844
## Getting Started ##
4945

50-
To get started using this model, refer to
46+
To get started using this library, refer to
5147
[its page on the **NTIA/ITS Propagation Library Wiki**](https://ntia.github.io/propagation-library-wiki/models/LFMF/).
5248
There, you will find installation instructions, usage information, and code
5349
examples for all supported languages.
5450

51+
An executable is also provided which can be used to run the functions provided
52+
by this library using plain text input and output files. Installation and usage
53+
details for the command-line driver are provided in [its own README](./app/README.md).
54+
5555
If you're a developer and would like to contribute to or extend this repository,
5656
you will find comprehensive documentation of this C++ code
5757
[here](https://ntia.github.io/LFMF), and a guide for contributors
@@ -86,9 +86,8 @@ In order to do either, ensure the required submodules are cloned by running:
8686

8787
```cmd
8888
# From this repository's root directory
89-
git submodule init extern/googletest # Required to run tests
90-
git submodule init extern/doxygen-awesome-css # Required to build docs
91-
git submodule update # Clones the initialized submodules
89+
git submodule init
90+
git submodule update
9291
```
9392

9493
## Running Tests ##
@@ -100,6 +99,9 @@ the "Release" or "Debug" CMake presets, you can run the included unit tests as f
10099
ctest --preset release
101100
```
102101

102+
Additionally, the [Study Group Clutter Excel Workbook](https://www.itu.int/en/ITU-R/study-groups/rsg3/ionotropospheric/Clutter%20and%20BEL%20workbook_V2.xlsx)
103+
contains an extensive set of example values which are useful as validation cases.
104+
103105
## References ##
104106

105107
* [ITS Propagation Library Wiki](https://ntia.github.io/propagation-library-wiki)

0 commit comments

Comments
 (0)