NTIA · aromanielloNTIA · Nov 1, 2024 · Nov 6, 2024 · Nov 21, 2024 · Nov 21, 2024
diff --git a/.github/workflows/quarto-publish.yml b/.github/workflows/quarto-publish.yml
@@ -28,7 +28,7 @@ jobs:
       uses: quarto-dev/quarto-actions/setup@v2
 
     - name: Setup Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.10'
     - run: pip install jupyter

diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,6 @@
 /.quarto/
 _site
-models/eHata
-models/ITM-MidBand
-models/TIREM
-models/P528
 **/index_files/
 **/*_files
 /env/
+.vscode
diff --git a/_quarto.yml b/_quarto.yml
@@ -9,7 +9,7 @@ website:
     description: |
       The NTIA/ITS Propagation Library: a versatile and robust set of
       tools for propagation modeling. Learn more on our wiki.
-    image: images/ntia-logo-300px.png
+    image: images/ntia-logo-dark-bg-1946px.png
     image-alt: National Telecommunications and Information Administration Logo
     image-width: 300
     image-height: 300
@@ -19,7 +19,7 @@ website:
     description: |
       The NTIA/ITS Propagation Library: a versatile and robust set of
       tools for propagation modeling. Learn more on our wiki.
-    image: images/ntia-logo-300px.png
+    image: images/ntia-logo-dark-bg-1200x630.png
     image-alt: National Telecommunications and Information Administration Logo
     image-width: 300
     image-height: 300
@@ -32,7 +32,7 @@ website:
         text: Home
       - text: "U.S. Models"
         menu:
-          - Coming Soon
+          - models/LFMF/index.qmd
       - text: "ITU-R Models"
         menu:
           - models/P2108/index.qmd

diff --git a/images/matlab/add-ons-menu.png b/images/matlab/add-ons-menu.png
diff --git a/images/matlab/add-to-matlab-menu.PNG b/images/matlab/add-to-matlab-menu.PNG
diff --git a/images/matlab/install-online.png b/images/matlab/install-online.png
diff --git a/images/matlab/manage-add-ons-context-menu.png b/images/matlab/manage-add-ons-context-menu.png
diff --git a/images/matlab/manage-add-ons-menu.png b/images/matlab/manage-add-ons-menu.png
diff --git a/images/ntia-logo-300px.png b/images/ntia-logo-300px.png
diff --git a/images/ntia-logo-dark-bg-1200x630.png b/images/ntia-logo-dark-bg-1200x630.png
diff --git a/images/ntia-logo-dark-bg-1946px.png b/images/ntia-logo-dark-bg-1946px.png
diff --git a/includes/_getting_started.qmd b/includes/_getting_started.qmd
@@ -2,6 +2,7 @@
 
 This page documents the inputs, outputs, and primary functions of this software in a language-agnostic way. Language-specific documentation is additionally provided for this library. The pages linked below include installation instructions as well as usage examples for each supported language.
 
+[Command-Line Driver](driver.qmd){.btn .btn-secondary role="button"}
 [C++](cpp.qmd){.btn .btn-secondary role="button"}
 [.NET](dotnet.qmd){.btn .btn-secondary role="button"}
 [MATLAB](matlab.qmd){.btn .btn-secondary role="button"}

diff --git a/includes/_cpp_documentation_block.qmd → includes/cpp/_documentation.qmd b/includes/_cpp_documentation_block.qmd → includes/cpp/_documentation.qmd
diff --git a/includes/driver/_general_usage.qmd b/includes/driver/_general_usage.qmd
@@ -0,0 +1,9 @@
+# General Usage
+
+## Input Files
+
+Inputs to the command-line driver are specified in an ASCII text file using the common `key,value` format. Each line holds a single `key,value` combination, with the `key` representing the model input variable name and the `value` representing its value. Refer to the [examples](#examples) below to see the specific keys required for this model's inputs. Note that key names are not case-sensitive.
+
+## Output Files
+
+After parsing the inputs and running the software, the command-line driver will generate an output report file containing the results. This file contains a record of the input parameters along with the model outputs and human-readable supporting details. Refer to the [examples](#examples) below to see the expected format of output files generated by this model.
diff --git a/includes/driver/_intro_and_installation.qmd b/includes/driver/_intro_and_installation.qmd
@@ -0,0 +1,9 @@
+Each model in the Propagation Library is distributed with an accompanying command-line driver program.
+This program allows the user to run the model from the command line on Windows, macOS, or Linux.
+The model inputs and outputs are handled using simple text files. No programming experience is required to
+use the command-line driver.
+
+{{< include /includes/_link_to_model_home.qmd >}}
+
+# Installation
+
diff --git a/includes/matlab/_documentation.qmd b/includes/matlab/_documentation.qmd
@@ -0,0 +1,3 @@
+## Documentation
+
+All functions and/or objects provided by this MATLAB Toolbox contain built-in help documentation. This means that you can find details about inputs, outputs, and usage syntax right from the MATLAB Command Window. For example:
diff --git a/includes/matlab/_examples.qmd b/includes/matlab/_examples.qmd
@@ -0,0 +1,13 @@
+## Examples
+
+The code examples provided here are also included in the toolbox itself, as MATLAB Live Scripts. To access these, view the toolbox "Getting Started" guide as follows.
+
+1. Once installed, view the toolbox in the **Add-Ons > Manage Add-Ons** menu as shown in @fig-matlab-manage-add-ons-menu-2.
+
+    ![](/images/matlab/manage-add-ons-menu.png){#fig-matlab-manage-add-ons-menu-2 fig-alt="A screenshot showing the MATLAB 'Manage Add-Ons' menu option" width=300 fig-align="left"}
+
+1. Find the installed toolbox in the list, and click the **⋮** icon and select **View Getting Started Guide** as shown in @fig-matlab-manage-add-ons-context-menu.
+
+    ![](/images/matlab/manage-add-ons-context-menu.png){#fig-matlab-manage-add-ons-context-menu fig-alt="A screenshot showing the context menu for an installed toolbox in the MATLAB 'Manage Add-Ons' menu" width=300 fig-align="left"}
+
+1. Under the **Examples** heading, links are provided for Live Script example programs which demonstrate usage of the toolbox in an interactive way. The same code examples are additionally provided below.
diff --git a/includes/matlab/_getting_started.qmd b/includes/matlab/_getting_started.qmd
@@ -0,0 +1,31 @@
+There are two easy ways to install the toolbox: [from a browser](#installing-from-a-browser) or [from within MATLAB](#installing-from-within-matlab).
+
+### Installation from a Browser
+
+1. Open this package's page on the File Exchange using the link provided [above](#getting-started).
+
+1. In the upper-right, click **Download > Toolbox** as shown in @fig-matlab-install-online. A file with a `.mltbx` extension will download.
+
+    ![](/images/matlab/install-online.png){#fig-matlab-install-online fig-alt="Screenshot showing the 'Download Toolbox' option on the MathWorks File Exchange website" width=250 fig-align="left"}
+
+1. Optionally, move the downloaded file into your project directory.
+
+1. Within MATLAB, navigate to the `.mltbx` file and double-click it.
+
+### Installation from Within MATLAB
+
+1. Open MATLAB and select **Add-Ons > Get Add-Ons** in the toolbar, as shown in @fig-matlab-add-ons-menu. The Add-On Explorer window will open.
+
+    ![](/images/matlab/add-ons-menu.png){#fig-matlab-add-ons-menu fig-alt="A screenshot showing the MATLAB 'Get Add-Ons' menu option" width=300 fig-align="left"}
+
+1. Search for this package by its name.
+
+1. In the upper-right, click **Add > Add to MATLAB** as shown in @fig-matlab-add-to-matlab-menu.
+
+    ![](/images/matlab/add-to-matlab-menu.png){#fig-matlab-add-to-matlab-menu fig-alt="A screenshot showing the 'Add to MATLAB' option for a toolbox within the Add-On Explorer" width=200 fig-align="left"}
+
+### Uninstallation
+
+Regardless of how you installed the toolbox, you can uninstall it at any time from the **Add-Ons > Manage Add-Ons** menu. This is available in the MATLAB toolbar as shown in @fig-matlab-manage-add-ons-menu.
+
+![](/images/matlab/manage-add-ons-menu.png){#fig-matlab-manage-add-ons-menu fig-alt="A screenshot showing the MATLAB 'Manage Add-Ons' menu option" width=300 fig-align="left"}
diff --git a/includes/_py_documentation_block.qmd → includes/python/_documentation.qmd b/includes/_py_documentation_block.qmd → includes/python/_documentation.qmd
diff --git a/includes/python/_getting_started.qmd b/includes/python/_getting_started.qmd
@@ -0,0 +1,12 @@
+## Getting Started
+
+All ITS PropLib Python packages require a
+[currently-supported](https://devguide.python.org/versions/)
+version of Python. You may choose to use a tool such as
+[pyenv](https://github.com/pyenv/pyenv) or
+[conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html)
+to manage multiple Python versions on your machine. Additionally,
+you may choose to set up a virtual environment for your project,
+using conda or a tool such as [`venv`](https://docs.python.org/3/library/venv.html).
+Installation instructions assume that you have a supported version of Python installed,
+and that you're working from the desired Python environment.
diff --git a/includes/python/_uninstallation.qmd b/includes/python/_uninstallation.qmd
@@ -0,0 +1,4 @@
+### Uninstallation
+
+Uninstalling this Python package is also simple. Run the following
+command in your Python environment.
diff --git a/index.qmd b/index.qmd
@@ -1,7 +1,7 @@
 ---
 title: "ITS Propagation Library Wiki"
 date: 2024-06-11
-date-modified: 2024-11-20
+date-modified: 2024-12-02
 ---
 
 The ITS Propagation Library (**"PropLib"**) is a collection of open source software developed by [ITS](about.qmd), focused on modeling radio wave propagation under a wide variety of circumstances. The library currently supports C++, .NET, MATLAB®, and Python users through exposing common functionality across multiple programming environments. One of the key benefits of this approach is that users are assured of identical results across languages, allowing researchers to work in their most efficient development environment while benefitting from common library improvements.
@@ -12,25 +12,35 @@ Currently, PropLib includes implementations of propagation models developed by t
 
 ### U.S. Propagation Models
 
+Over the years, ITS has developed and refined various programs for the prediction of radio propagation in a wide range of situations.  
+
 Documentation pages are being worked on, and will soon be available through links in the following table, for the following U.S. propagation models:
 
 ::: {.callout-warning}
 ## Page Under Construction
 
-The listed U.S. propagation models have public code repositories, but
+The HF, IF77, and MPM models are distributed as legacy software, and do not
+yet have public GitHub repositories.
+The eHata and ITM models have public code repositories, but
 documentation is not yet available on this website. Please check back
 later, and contact [[email protected]](mailto:[email protected]) with questions
 in the meantime.
 :::
 
-+----------:+:-------------------------------------:+:----:+:---------------------------------------------------+
-| **eHata** | [Repo](https://github.com/NTIA/eHata) | Docs | Extended Hata Urban Propagation Model              |
-+-----------+---------------------------------------+------+----------------------------------------------------+
-| **ITM**   | [Repo](https://github.com/NTIA/ITM)   | Docs | Irregular Terrain Model                            |
-+-----------+---------------------------------------+------+----------------------------------------------------+
-| **LFMF**  | [Repo](https://github.com/NTIA/LFMF)  | Docs | Low Frequency / Medium Frequency Propagation Model |
-+-----------+---------------------------------------+------+----------------------------------------------------+
-: U.S. propagation models available in the ITS Propagation Library {tbl-colwidths="[15,10,10,65]"}
++----------:+:-------------------------------------:+:-----------------------------------------------------------------------:+:---------------------------------------------------+
+| **eHata** | [Repo](https://github.com/NTIA/eHata) | Docs                                                                    | Extended Hata Urban Propagation Model              |
++-----------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------+
+| **HF**    | [Legacy Software](https://its.ntia.gov/software/high-frequency/high-frequency-propagation-models/)              | High Frequency Propagation Models                  |
++-----------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------+
+| **IF77**  | [Legacy Software](https://its.ntia.gov/software/if-77-electromagnetic-wave-propagation-model-gierhart-johnson/) | The IF-77 Electromagnetic Wave Propagation Model   |
++-----------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------+
+| **ITM**   | [Repo](https://github.com/NTIA/ITM)   | Docs                                                                    | Irregular Terrain Model                            |
++-----------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------+
+| **LFMF**  | [Repo](https://github.com/NTIA/LFMF)  | [Docs](models/LFMF/)                                                    | Low Frequency / Medium Frequency Propagation Model |
++-----------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------+
+| **MPM**   | [Legacy Software](https://its.ntia.gov/software/millimeter-wave-propagation-model-mpm/)                         | Millimeter-wave Propagation Model                  |
++-----------+---------------------------------------+-------------------------------------------------------------------------+----------------------------------------------------+
+: U.S. propagation models available in the ITS Propagation Library {tbl-colwidths="[15,20,10,55]"}
 
 ### ITU-R Recommendations
 
@@ -43,10 +53,10 @@ The P.528 model has a public code repository, but documentation is not yet avail
 in the meantime.
 :::
 
-+-----------:+:-------------------------------------:+:------------------------------:+:------------------------------------------------------------+
-| **P.528**  | [Repo](https://github.com/NTIA/P528)  | Docs                           | A propagation prediction method for aeronautical mobile and |
-|            |                                       |                                | radionavigation services using the VHF, UHF, and SHF bands  |
-+------------+---------------------------------------+--------------------------------+-------------------------------------------------------------+
-| **P.2108** | [Repo](https://github.com/NTIA/p2108) | [Docs](models/P2108/index.qmd) | Prediction of clutter loss                                  |
-+------------+---------------------------------------+--------------------------------+-------------------------------------------------------------+
++-----------:+:-------------------------------------:+:---------------------:+:------------------------------------------------------------+
+| **P.528**  | [Repo](https://github.com/NTIA/P528)  | Docs                  | A propagation prediction method for aeronautical mobile and |
+|            |                                       |                       | radionavigation services using the VHF, UHF, and SHF bands  |
++------------+---------------------------------------+-----------------------+-------------------------------------------------------------+
+| **P.2108** | [Repo](https://github.com/NTIA/p2108) | [Docs](models/P2108/) | Prediction of clutter loss                                  |
++------------+---------------------------------------+-----------------------+-------------------------------------------------------------+
 : ITU-R Recommendations implemented in the ITS Propagation Library {tbl-colwidths="[15,10,10,65]"}
diff --git a/models/ITM/_metadata.yml b/models/ITM/_metadata.yml
diff --git a/models/ITM/cpp.qmd b/models/ITM/cpp.qmd
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Documentation

		All functions and/or objects provided by this MATLAB Toolbox contain built-in help documentation. This means that you can find details about inputs, outputs, and usage syntax right from the MATLAB Command Window. For example: