From 388351b5cba334cb75a71f53a914961d558b7d8c Mon Sep 17 00:00:00 2001 From: Quarto GHA Workflow Runner Date: Tue, 11 Jun 2024 20:44:53 +0000 Subject: [PATCH] Built site for gh-pages --- .nojekyll | 2 +- CONTRIBUTING.html | 21 +- LICENSE.html | 13 +- about.html | 13 +- index.html | 141 ++++-- models/ITM-MidBand/cpp.html | 592 ----------------------- models/ITM-MidBand/dotnet.html | 820 -------------------------------- models/ITM-MidBand/index.html | 634 ------------------------- models/ITM-MidBand/matlab.html | 833 --------------------------------- models/ITM-MidBand/python.html | 827 -------------------------------- models/ITM/cpp.html | 13 +- models/ITM/dotnet.html | 13 +- models/ITM/index.html | 13 +- models/ITM/matlab.html | 13 +- models/ITM/python.html | 13 +- models/P2108/cpp.html | 13 +- models/P2108/dotnet.html | 13 +- models/P2108/index.html | 13 +- models/P2108/matlab.html | 13 +- models/P2108/python.html | 13 +- quick-start/cpp.html | 13 +- quick-start/dotnet.html | 13 +- quick-start/matlab.html | 13 +- quick-start/python.html | 13 +- search.json | 574 +++++++---------------- sitemap.xml | 80 ++-- 26 files changed, 378 insertions(+), 4354 deletions(-) delete mode 100644 models/ITM-MidBand/cpp.html delete mode 100644 models/ITM-MidBand/dotnet.html delete mode 100644 models/ITM-MidBand/index.html delete mode 100644 models/ITM-MidBand/matlab.html delete mode 100644 models/ITM-MidBand/python.html diff --git a/.nojekyll b/.nojekyll index fa3ba47..6ad341c 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -259a7910 \ No newline at end of file +9150b79c \ No newline at end of file diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index de14c4c..f881b92 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -7,7 +7,7 @@ -NTIA/ITS Propagation Library Wiki +ITS Propagation Library Wiki +/* CSS for citations */ +div.csl-bib-body { } +div.csl-entry { + clear: both; + margin-bottom: 0em; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} @@ -80,7 +100,7 @@
- NTIA/ITS PropLib Wiki + ITS PropLib Wiki
@@ -98,14 +118,7 @@ U.S. Models
  • @@ -153,7 +166,7 @@

    Contents

    -

    NTIA/ITS Propagation Library Wiki

    +

    ITS Propagation Library Wiki

    @@ -182,6 +195,18 @@

    NTIA/ITS Propagation Library Wiki

    +

    The ITS Propagation Library (“PropLib”) is a collection of open source software developed by ITS, focused on modeling radio wave propagation under a wide variety of circumstances. The library currently supports C++, 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.

    +
    +

    Quick Start

    +

    For each supported programming language, we’ve prepared “quick start” guides to help you get up and running with PropLib software. These pages should be helpful regardless of which specific package(s) you may be interested in using. Choose your programming language below to get started.

    +

    C++ C#/.NET MATLAB Python

    +
    +
    +

    Packages

    +

    Currently, PropLib includes implementations of propagation models developed by the U.S. (NTIA/ITS) and by the International Telecommunication Union Radiocommunication Sector (ITU-R). The following are categorized lists of available packages within PropLib.

    +
    +

    U.S. Propagation Models

    +

    Documentation pages are being worked on, and will soon be available through links in the following table, for the following U.S. propagation models:

    @@ -192,35 +217,89 @@

    NTIA/ITS Propagation Library Wiki

    -

    This page is still under construction and has not yet been finalized. Information may be outdated, incorrect, or missing. While this message is visible, contact code@ntia.gov with any questions.

    +

    The listed U.S. propagation models have public code repositories, but documentation is not yet available on this website. Please check back later, and contact code@ntia.gov with questions in the meantime.

    -

    The NTIA/ITS Propagation Library (“PropLib”) is a collection of open source software developed by ITS, focused on modeling radio wave propagation under a wide variety of circumstances. The library currently supports C++, 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.

    -
    -

    Quick Start

    -

    For each supported programming language, we’ve prepared “quick start” guides to help you get up and running with PropLib software. These pages should be helpful regardless of which specific package(s) you may be interested in using. Choose your programming language below to get started.

    -

    C++ C#/.NET MATLAB Python

    -
    -
    -

    Packages

    -

    The following are categorized lists of available packages within the NTIA/ITS Propagation Library. Currently, this includes U.S. and ITU-R propagation models.

    -
    -

    U.S. Propagation Models

    -
      -
    • ITM: [Repo | Docs] - The Irregular Terrain Model
      • -
    + + ++++++ + + + + + + + + + + + + + + + + + + + + +
    U.S. propagation models available in the ITS Propagation Library
    eHataRepoDocsExtended Hata Urban Propagation Model
    ITMRepoDocsIrregular Terrain Model
    LFMFRepoDocsLow Frequency / Medium Frequency Propagation Model

    ITU-R Recommendations

    -
      -
    • P.2108: [Repo | Docs] - Prediction of clutter loss
      • -
    +

    The ITU-R Recommendations constitute a set of international technical standards developed by the Radiocommunication Sector (formerly CCIR) of the ITU [1]. A subset of these have been implemented in software as a part of this library by ITS.

    +
    +
    +
    + +
    +
    +Page Under Construction +
    +
    +
    +

    The P.528 model has a public code repository, but documentation is not yet available on this website. Please check back later, and contact code@ntia.gov with questions in the meantime.

    +
    +
    + + ++++++ + + + + + + + + + + + + + + +
    ITU-R Recommendations implemented in the ITS Propagation Library
    P.528RepoDocsA propagation prediction method for aeronautical mobile and radionavigation services using the VHF, UHF, and SHF bands
    P.2108RepoDocsPrediction of clutter loss
    +
    - +

    References

    +
    +
    [1]
    “ITU-R Recommendations.” https://www.itu.int/pub/R-REC.
    +
    +
    - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - -
    - -
    - - - - -
    - -
    -
    -

    ITM-MidBand - C++

    -
    - - - -
    - - - - -
    - - - -
    - - -
    -
    -
    - -
    -
    -Page Under Construction -
    -
    -
    -

    This page is still under construction and has not yet been finalized. Information may be outdated,incorrect, or missing. While this message is visible, contact code@ntia.gov with any questions.

    -
    -
    - - - -
    - -
    - - - - - \ No newline at end of file diff --git a/models/ITM-MidBand/dotnet.html b/models/ITM-MidBand/dotnet.html deleted file mode 100644 index 5fd67af..0000000 --- a/models/ITM-MidBand/dotnet.html +++ /dev/null @@ -1,820 +0,0 @@ - - - - - - - - - -NTIA/ITS Propagation Library Wiki - ITM-MidBand - C#/.NET - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - -
    - -
    - - - - -
    - -
    -
    -

    ITM-MidBand - C#/.NET

    -
    - - - -
    - - - - -
    - - - -
    - - -
    -
    -
    - -
    -
    -Page Under Construction -
    -
    -
    -

    This page is still under construction and has not yet been finalized. Information may be outdated,incorrect, or missing. While this message is visible, contact code@ntia.gov with any questions.

    -
    -
    -
    -

    Getting Started

    -

    To begin, install the NuGet package, ITM, from the NTIA NuGet repository

    -
    -
    -

    -
    itm nuget install screenshot
    -
    -
    -

    All of the below code snippets requires the including the following using statement.

    -
    using ITS.Propagation;
    -
    -
    -

    Documentation

    -

    The itm library is packaged to support IntelliSense when developing in Visual Studio. This documentation will provide the developer with information on function descriptions, variable details, etc.

    -
    -
    -

    Examples

    -

    Note: These examples use an artificial terrain profile.

    -
    -

    Point-to-Point Basic Transmission Loss (TLS)

    -
    // define the terrain profile in PFL format
-var pfl = new double[] { 5, 200, 5, 7, 2, 4, 7, 5 };
-
-// define link parameters
-double f__mhz = 3500;                      // MHz
-double h_tx__meter = 10;                   // meters, AGL
-double h_rx__meter = 5;                    // meters, AGL
-double N_0 = 301;                          // N-Units
-double epsilon = 15;                       // average ground
-double sigma = 0.005;                      // average ground
-var climate = ITM.Climate.ContinentalTemperate;
-var pol = ITM.Polarization.Horizontal;
-
-// define variability parameters
-int mdvar = 13;
-double time = 50;                          // median
-double location = 50;                      // median
-double situation = 50;                     // median
-
-// call ITM
-int rtn = ITM.ITM_P2P_TLS_Ex(h_tx__meter, h_rx__meter, pfl,
-    climate, N_0, f__mhz, pol, epsilon, sigma, mdvar,
-    time, location, situation, out double A__db, 
-    out ITM.Warnings warnings, out ITM.IntermediateValues ivals);
-
-// rtn = 0                                 // no errors
-// A__db = 105.8590                        // basic transmission loss, in dB
-// warnings = 0                            // no warnings
-
-// can use the intermediate values object to access additional information
-// from the ITM prediction
-Console.WriteLine($"The mode of propagation is {ivals.Mode}");
-Console.WriteLine($"The effective height of the TX is {ivals.h_e__meter[0]} meters");
-Console.WriteLine($"The free space basic transmission loss is {ivals.A_fs__db} dB");
-// The mode of propagation is LineOfSight
-// The effective height of the TX is 10.222222222222221 meters.
-// The free space basic transmission loss is 103.33136088700552 dB.
    -
    -
    -

    Point-to-Point Basic Transmission Loss (CR)

    -
    // define the terrain profile in PFL format
-var pfl = new double[] { 5, 200, 5, 7, 2, 4, 7, 5 };
-
-// define link parameters
-double f__mhz = 1500;                      // MHz
-double h_tx__meter = 10;                   // meters, AGL
-double h_rx__meter = 5;                    // meters, AGL
-double N_0 = 301;                          // N-Units
-double epsilon = 15;                       // average ground
-double sigma = 0.005;                      // average ground
-var climate = ITM.Climate.ContinentalTemperate;
-var pol = ITM.Polarization.Horizontal;
-
-// define variability parameters
-int mdvar = 13;
-double confidence = 50;                    // median
-double reliability = 50;                   // median
-
-// call ITM
-int rtn = ITM.ITM_P2P_CR_Ex(h_tx__meter, h_rx__meter, pfl,
-    climate, N_0, f__mhz, pol, epsilon, sigma, mdvar,
-    confidence, reliability, out double A__db, 
-    out ITM.Warnings warnings, out ITM.IntermediateValues ivals);
-
-// rtn = 0                                 // no errors
-// A__db = 99.9744                         // basic transmission loss, in dB
-// warnings = 0                            // no warnings
-
-// can use the intermediate values object to access additional information
-// from the ITM prediction
-Console.WriteLine($"The mode of propagation is {ivals.Mode}");
-Console.WriteLine($"The effective height of the TX is {ivals.h_e__meter[0]} meters");
-Console.WriteLine($"The free space basic transmission loss is {ivals.A_fs__db} dB");
-// The mode of propagation is LineOfSight
-// The effective height of the TX is 10.222222222222221 meters.
-// The free space basic transmission loss is 95.971825 dB.
    -
    -
    -

    Area Mode Basic Transmission Loss (TLS)

    -
    // define link parameters
-double f__mhz = 1500;                      // MHz
-double h_tx__meter = 10;                   // meters, AGL
-double h_rx__meter = 5;                    // meters, AGL
-double N_0 = 301;                          // N-Units
-double epsilon = 15;                       // average ground
-double sigma = 0.005;                      // average ground
-double d__km = 100;                        // km
-double delta_h__meter = 40;                // meter
-var tx_site_criteria = ITM.SitingCriteria.Careful;
-var rx_site_criteria = ITM.SitingCriteria.Careful;
-var climate = ITM.Climate.ContinentalTemperate;
-var pol = ITM.Polarization.Horizontal;
-
-// define variability parameters
-int mdvar = 13;
-double time = 50;                          // median
-double location = 50;                      // median
-double situation = 50;                     // median
-
-// call ITM
-int rtn = ITM.ITM_AREA_TLS_Ex(h_tx__meter, h_rx__meter,
-    tx_site_criteria, rx_site_criteria, d__km, delta_h__meter,
-    climate, N_0, f__mhz, pol, epsilon, sigma, mdvar,
-    time, location, situation, out double A__db,
-    out ITM.Warnings warnings, out ITM.IntermediateValues ivals);
-// rtn = 0                                 // no errors
-// A__db = 191.0266                        // basic transmission loss, in dB
-// warnings = 0                            // no warnings
-
-// can use the intermediate values object to access additional information
-// from the ITM prediction
-Console.WriteLine($"The mode of propagation is {ivals.Mode}");
-Console.WriteLine($"The effective height of the TX is {ivals.h_e__meter[0]} meters.");
-Console.WriteLine($"The free space basic transmission loss is {ivals.A_fs__db} dB.");
-// The mode of propagation is Troposcatter
-// The effective height of the TX is 13.032653 meters.
-// The free space basic transmission loss is 135.971825 dB.
    -
    -
    -

    Area Mode Basic Transmission Loss (CR)

    -
    // define link parameters
-double f__mhz = 5000;                      // MHz
-double h_tx__meter = 10;                   // meters, AGL
-double h_rx__meter = 5;                    // meters, AGL
-double N_0 = 301;                          // N-Units
-double epsilon = 15;                       // average ground
-double sigma = 0.005;                      // average ground
-double d__km = 100;                        // km
-double delta_h__meter = 40;                // meter
-var tx_site_criteria = ITM.SitingCriteria.Careful;
-var rx_site_criteria = ITM.SitingCriteria.Careful;
-var climate = ITM.Climate.ContinentalTemperate;
-var pol = ITM.Polarization.Horizontal;
-
-// define variability parameters
-int mdvar = 13;
-double confidence = 50;                    // median
-double reliability = 50;                   // median
-
-// call ITM
-int rtn = ITM.ITM_AREA_CR_Ex(h_tx__meter, h_rx__meter,
-    tx_site_criteria, rx_site_criteria, d__km, delta_h__meter,
-    climate, N_0, f__mhz, pol, epsilon, sigma, mdvar,
-    confidence, reliability, out double A__db,
-    out ITM.Warnings warnings, out ITM.IntermediateValues ivals);
-// rtn = 0                                 // no errors
-// A__db = 205.7474                        // basic transmission loss, in dB
-// warnings = 0                            // no warnings
-
-// can use the intermediate values object to access additional information
-// from the ITM prediction
-Console.WriteLine($"The mode of propagation is {ivals.Mode}");
-Console.WriteLine($"The effective height of the TX is {ivals.h_e__meter[0]} meters.");
-Console.WriteLine($"The free space basic transmission loss is {ivals.A_fs__db} dB.");
-// The mode of propagation is Troposcatter
-// The effective height of the TX is 13.032653 meters.
-// The free space basic transmission loss is 146.429400 dB.
    - - -
    -
    - -
    - -
    - - - - - \ No newline at end of file diff --git a/models/ITM-MidBand/index.html b/models/ITM-MidBand/index.html deleted file mode 100644 index 8d4ee45..0000000 --- a/models/ITM-MidBand/index.html +++ /dev/null @@ -1,634 +0,0 @@ - - - - - - - - - -NTIA/ITS Propagation Library Wiki - ITM-MidBand - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - -
    - -
    - - - - -
    - -
    -
    -

    ITM-MidBand

    -
    - - - -
    - - - - -
    - - - -
    - - -
    -
    -
    - -
    -
    -Page Under Construction -
    -
    -
    -

    This page is still under construction and has not yet been finalized. Information may be outdated, incorrect, or missing. While this message is visible, contact code@ntia.gov with any questions.

    -
    -
    -

    A description of the Irregular Terrain Model (ITM), as well as details on input parameters, can be found at the public GitHub repo.

    -
    -

    Getting Started

    -

    Language-specific information on getting started using this library, including installation instructions, is available by following these links:

    -

    C++ C#/.NET MATLAB Python

    -
    -
    -

    Functions

    -
    -

    Point-to-Point Basic Transmission Loss (TLS)

    -

    Generate a basic transmission loss prediction by operating ITM in point-to-point mode. Variabilities are provided as time, location, and situation percentages.

    -

    Example: C# | MATLAB | Python

    -
    -
    -

    Point-to-Point Basic Transmission Loss (CR)

    -

    Generate a basic transmission loss prediction by operating ITM in point-to-point mode. Variabilities are provided as confidence and reliability percentages.

    -

    Example: C# | MATLAB | Python

    -
    -
    -

    Area Mode Basic Transmission Loss (TLS)

    -

    Generate a basic transmission loss prediction by operating ITM in area mode. Variabilities are provided as time, location, and situation percentages.

    -

    Example: C# | MATLAB | Python

    -
    -
    -

    Area Mode Basic Transmission Loss (CR)

    -

    Generate a basic transmission loss prediction by operating ITM in area mode. Variabilities are provided as confidence and reliability percentages.

    -

    Example: C# | MATLAB | Python

    - - -
    -
    - -
    - -
    - - - - - \ No newline at end of file diff --git a/models/ITM-MidBand/matlab.html b/models/ITM-MidBand/matlab.html deleted file mode 100644 index 7ef3072..0000000 --- a/models/ITM-MidBand/matlab.html +++ /dev/null @@ -1,833 +0,0 @@ - - - - - - - - - -NTIA/ITS Propagation Library Wiki - ITM-MidBand - MATLAB - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - -
    - -
    - - - - -
    - -
    -
    -

    ITM-MidBand - MATLAB

    -
    - - - -
    - - - - -
    - - - -
    - - -
    -
    -
    - -
    -
    -Page Under Construction -
    -
    -
    -

    This page is still under construction and has not yet been finalized. Information may be outdated,incorrect, or missing. While this message is visible, contact code@ntia.gov with any questions.

    -
    -
    -

    The package name to install is itm. The package can be found in the matpak repo with the following command:

    -
    matpak search itm
    -
    -

    Installing Package

    -

    Use the following command to install itm from the matpak repo:

    -
    matpak install itm
    -

    The packag can be installed directly into your working directory or in a seperate directory that you include in your execution path.

    -
    -
    -

    Documentation

    -

    All itm functions are docummented with detailed headers, such as:

    -
    % Function ITM_P2P_TLS(...)
-%
-% Description: Calculates the propagation loss between antennas
-%       using ITM
-%
-% Inputs:
-%   h_tx__meter : Structural height of the TX, in meters
-%   h_rx__meter : Structural height of the RX, in meters
-%   radio_climate : Radio climate
-%   time : Time percentage (0 < p < 100)
-%   location : Location percentage (0 < p < 100)
-%   situation : Situation percentage (0 < p < 100)
-%   pfl : Terrain data, in PFL format
-%   N_0 : Refractivity, in N-Units
-%   f__mhz : Frequency, in MHz
-%   polarization : Polarization
-%   epsilon : Relative permittivity
-%   sigma : Conductivity
-%   mdvar : Mode of variability
-%
-% Outputs:
-%   rtn : Error code
-%   A__db : Basic transmission loss, in dB
-%   warnings : Warning flags
-%   interValues : Intermedate values
    -
    -
    -

    Examples

    -

    Note: These examples use an artificial terrain profile.

    -
    -

    Point-to-Point Basic Transmission Loss (TLS)

    -
    % define the terrain profile in PFL format
-pfl = [5, 200, 5, 7, 2, 4, 7, 5];
-
-% define link parameters
-f__mhz = 3500;                      % MHz
-h_tx__meter = 10;                   % meters, AGL
-h_rx__meter = 5;                    % meters, AGL
-N_0 = 301;                          % N-Units
-epsilon = 15;                       % average ground
-sigma = 0.005;                      % average ground
-climate = ITMClimate.ContinentalTemperate;
-pol = ITMPolarization.Horizontal;
-
-% define variability parameters
-mdvar = 13;
-time = 50;                          % median
-location = 50;                      % median
-situation = 50;                     % median
-
-% call ITM
-[rtn, A__db, warnings, ivals] = ITM.ITM_P2P_TLS(h_tx__meter, h_rx__meter, ...
-    pfl, climate, N_0, f__mhz, pol, epsilon, sigma, mdvar, ...
-    time, location, situation)
-% rtn = 0                           % no errors
-% A__db = 105.8590                  % basic transmission loss, in dB
-% warnings = 0                      % no warnings
-
-% can use the intermediate values object to access additional information
-% from the ITM prediction
-fprintf('The mode of propagation is %s\n', ivals.Mode)
-fprintf('The effective height of the TX is %f meters\n', ivals.h_e__meter(1))
-fprintf('The free space basic transmission loss is %f dB\n', ivals.A_fs__db)
-% The mode of propagation is LineOfSight
-% The effective height of the TX is 10.222222222222221 meters.
-% The free space basic transmission loss is 103.33136088700552 dB.
    -
    -
    -

    Point-to-Point Basic Transmission Loss (CR)

    -
    % define the terrain profile in PFL format
-pfl = [5, 200, 5, 7, 2, 4, 7, 5];
-
-% define link parameters
-f__mhz = 1500;                      % MHz
-h_tx__meter = 10;                   % meters, AGL
-h_rx__meter = 5;                    % meters, AGL
-N_0 = 301;                          % N-Units
-epsilon = 15;                       % average ground
-sigma = 0.005;                      % average ground
-climate = ITMClimate.ContinentalTemperate;
-pol = ITMPolarization.Horizontal;
-
-% define variability parameters
-mdvar = 13;
-confidence = 50;                    % median
-reliability = 50;                   % median
-
-% call ITM
-[rtn, A__db, warnings, ivals] = ITM.ITM_P2P_CR(h_tx__meter, h_rx__meter, ...
-    pfl, climate, N_0, f__mhz, pol, epsilon, sigma, mdvar, ...
-    confidence, reliability)
-% rtn = 0                           % no errors
-% A__db = 99.9744                   % basic transmission loss, in dB
-% warnings = 0                      % no warnings
-
-% can use the intermediate values object to access additional information
-% from the ITM prediction
-fprintf('The mode of propagation is %s\n', ivals.Mode)
-fprintf('The effective height of the TX is %f meters\n', ivals.h_e__meter(1))
-fprintf('The free space basic transmission loss is %f dB\n', ivals.A_fs__db)
-% The mode of propagation is LineOfSight
-% The effective height of the TX is 10.222222222222221 meters.
-% The free space basic transmission loss is 95.971825 dB.
    -
    -
    -

    Area Mode Basic Transmission Loss (TLS)

    -
    % define link parameters
-f__mhz = 1500;                      % MHz
-h_tx__meter = 10;                   % meters, AGL
-h_rx__meter = 5;                    % meters, AGL
-N_0 = 301;                          % N-Units
-epsilon = 15;                       % average ground
-sigma = 0.005;                      % average ground
-d__km = 100;                        % km
-delta_h__meter = 40;                % meter
-tx_site_criteria = ITMSitingCriteria.Careful;
-rx_site_criteria = ITMSitingCriteria.Careful;
-climate = ITMClimate.ContinentalTemperate;
-pol = ITMPolarization.Horizontal;
-
-% define variability parameters
-mdvar = 13;
-time = 50;                          % median
-location = 50;                      % median
-situation = 50;                     % median
-
-% call ITM
-[rtn, A__db, warnings, ivals] = ITM.ITM_AREA_TLS(h_tx__meter, h_rx__meter, ... 
-    tx_site_criteria, rx_site_criteria, d__km, delta_h__meter, climate, ...
-    N_0, f__mhz, pol, epsilon, sigma, mdvar, time, location, situation)
-% rtn = 0                           % no errors
-% A__db = 191.0266                  % basic transmission loss, in dB
-% warnings = 0                      % no warnings
-
-% can use the intermediate values object to access additional information
-% from the ITM prediction
-fprintf('The mode of propagation is %s\n', ivals.Mode)
-fprintf('The effective height of the TX is %f meters.\n', ivals.h_e__meter(1))
-fprintf('The free space basic transmission loss is %f dB.\n', ivals.A_fs__db)
-% The mode of propagation is Troposcatter
-% The effective height of the TX is 13.032653 meters.
-% The free space basic transmission loss is 135.971825 dB.
    -
    -
    -

    Area Mode Basic Transmission Loss (CR)

    -
    % define link parameters
-f__mhz = 5000;                      % MHz
-h_tx__meter = 10;                   % meters, AGL
-h_rx__meter = 5;                    % meters, AGL
-N_0 = 301;                          % N-Units
-epsilon = 15;                       % average ground
-sigma = 0.005;                      % average ground
-d__km = 100;                        % km
-delta_h__meter = 40;                % meter
-tx_site_criteria = ITMSitingCriteria.Careful;
-rx_site_criteria = ITMSitingCriteria.Careful;
-climate = ITMClimate.ContinentalTemperate;
-pol = ITMPolarization.Horizontal;
-
-% define variability parameters
-mdvar = 13;
-confidence = 50;                    % median
-reliability = 50;                   % median
-
-% call ITM
-[rtn, A__db, warnings, ivals] = ITM.ITM_AREA_CR(h_tx__meter, h_rx__meter, ... 
-    tx_site_criteria, rx_site_criteria, d__km, delta_h__meter, climate, ...
-    N_0, f__mhz, pol, epsilon, sigma, mdvar, confidence, reliability)
-% rtn = 0                           % no errors
-% A__db = 205.7474                  % basic transmission loss, in dB
-% warnings = 0                      % no warnings
-
-% can use the intermediate values object to access additional information
-% from the ITM prediction
-fprintf('The mode of propagation is %s\n', ivals.Mode)
-fprintf('The effective height of the TX is %f meters.\n', ivals.h_e__meter(1))
-fprintf('The free space basic transmission loss is %f dB.\n', ivals.A_fs__db)
-% The mode of propagation is Troposcatter
-% The effective height of the TX is 13.032653 meters.
-% The free space basic transmission loss is 146.429400 dB.
    - - -
    -
    - -
    - -
    - - - - - \ No newline at end of file diff --git a/models/ITM-MidBand/python.html b/models/ITM-MidBand/python.html deleted file mode 100644 index 8acbacb..0000000 --- a/models/ITM-MidBand/python.html +++ /dev/null @@ -1,827 +0,0 @@ - - - - - - - - - -NTIA/ITS Propagation Library Wiki - ITM-MidBand - Python - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - -
    - -
    - - - - -
    - -
    -
    -

    ITM-MidBand - Python

    -
    - - - -
    - - - - -
    - - - -
    - - -
    -
    -
    - -
    -
    -Page Under Construction -
    -
    -
    -

    This page is still under construction and has not yet been finalized. Information may be outdated,incorrect, or missing. While this message is visible, contact code@ntia.gov with any questions.

    -
    -
    -

    The package name to install is itm

    -
    import itm
-
-print(itm.__version__)
    -

    or

    -
    >> pip show itm
    -
    -

    Dependencies

    -

    The itm package requires numpy.

    -
    -
    -

    Installing Package

    -

    Use the following command to install itm from the local pip repo:

    -
    pip install itm --no-index --find-links file://itsfs01/Tools/Python/pip
    -
    -
    -

    Getting Started

    -

    Importing itm is as simple as including the following in your .py file:

    -
    import itm
    -
    -
    -

    Documentation

    -

    All itm functions contain built-in docstring help. This means that if your python development editor supports it, it can provide you with assistance on information such as function description, parameter types and descriptions, and return details.

    -

    This also means that help() is supported in the console to provide information.

    -
    -
    -

    Examples

    -

    Note: These examples use an artificial terrain profile as a python list. The itm package supports terrain profiles to be passed as either python lists or numpy arrays.

    -
    -

    Site Specific Basic Transmission Loss (TLS)

    -
    # define the terrain profile in PFL format
-pfl = [5, 200, 5, 7, 2, 4, 7, 5]
-
-# define link parameters
-f__mhz = 3500                       # MHz
-h_tx__meter = 10                    # meters, AGL
-h_rx__meter = 5                     # meters, AGL
-N_0 = 301                           # N-Units
-epsilon = 15                        # average ground
-sigma = 0.005                       # average ground
-climate = itm.Climate.ContinentalTemperate
-pol = itm.Polarization.Horizontal
-
-# define variability parameters
-mdvar = 13
-time = 50                           # median
-location = 50                       # median
-situation = 50                      # median
-
-# call ITM
-rtn, A__db, warnings, ivals = itm.ITM_P2P_TLS(h_tx__meter, h_rx__meter, 
-    pfl, climate, N_0, f__mhz, pol, epsilon, sigma, mdvar, 
-    time, location, situation)
-
-assert(rtn == 0)                    # no errors
-assert(A__db == 105.85899333756423) # basic transmission loss, in dB
-assert(warnings == 0)               # no warnings
-
-# can use the intermediate values object to access additional information
-# from the ITM prediction
-print(f"The mode of propagation is {ivals.mode.name}")
-print(f"The effective height of the TX is {ivals.h_e__meter[0]} meters.")
-print(f"The free space basic transmission loss is {ivals.A_fs__db} dB.")
-# The mode of propagation is LineOfSight
-# The effective height of the TX is 10.222222222222221 meters.
-# The free space basic transmission loss is 103.33136088700552 dB.
    -
    -
    -

    Site Specific Basic Transmission Loss (CR)

    -
    # define the terrain profile in PFL format
-pfl = [5, 200, 5, 7, 2, 4, 7, 5]
-
-# define link parameters
-f__mhz = 1500                       # MHz
-h_tx__meter = 10                    # meters, AGL
-h_rx__meter = 5                     # meters, AGL
-N_0 = 301                           # N-Units
-epsilon = 15                        # average ground
-sigma = 0.005                       # average ground
-climate = itm.Climate.ContinentalTemperate
-pol = itm.Polarization.Horizontal
-
-# define variability parameters
-mdvar = 13
-confidence = 50                     # median
-reliability = 50                    # median
-
-# call ITM
-rtn, A__db, warnings, ivals = itm.ITM_P2P_CR(h_tx__meter, h_rx__meter, 
-    pfl, climate, N_0, f__mhz, pol, epsilon, sigma, mdvar, confidence, 
-    reliability)
-
-assert(rtn == 0)                    # no errors
-assert(A__db == 99.97444366973738)  # basic transmission loss, in dB
-assert(warnings == 0)               # no warnings
-
-# can use the intermediate values object to access additional information
-# from the ITM prediction
-print(f"The mode of propagation is {ivals.mode.name}")
-print(f"The effective height of the TX is {ivals.h_e__meter[0]} meters.")
-print(f"The free space basic transmission loss is {ivals.A_fs__db} dB.")
-# The mode of propagation is LineOfSight
-# The effective height of the TX is 10.222222222222221 meters.
-# The free space basic transmission loss is 95.97182518111363 dB.
    -
    -
    -

    Area Mode Basic Transmission Loss (TLS)

    -
    # define link parameters
-f__mhz = 1500                       # MHz
-h_tx__meter = 10                    # meters, AGL
-h_rx__meter = 5                     # meters, AGL
-N_0 = 301                           # N-Units
-epsilon = 15                        # average ground
-sigma = 0.005                       # average ground
-d__km = 100                         # km
-delta_h__meter = 40                 # meter
-tx_site_criteria = itm.SitingCriteria.Careful
-rx_site_criteria = itm.SitingCriteria.Careful
-climate = itm.Climate.ContinentalTemperate
-pol = itm.Polarization.Horizontal
-
-# define variability parameters
-mdvar = 13
-time = 50                           # median
-location = 50                       # median
-situation = 50                      # median
-
-# call ITM
-rtn, A__db, warnings, ivals = itm.ITM_AREA_TLS(h_tx__meter, h_rx__meter, 
-    tx_site_criteria, rx_site_criteria, d__km, delta_h__meter, climate, 
-    N_0, f__mhz, pol, epsilon, sigma, mdvar, time, location, situation)
-
-assert(rtn == 0)                    # no errors
-assert(A__db == 191.02659749297175) # basic transmission loss, in dB
-assert(warnings == 0)               # no warnings
-
-# can use the intermediate values object to access additional information
-# from the ITM prediction
-print(f"The mode of propagation is {ivals.mode.name}")
-print(f"The effective height of the TX is {ivals.h_e__meter[0]} meters.")
-print(f"The free space basic transmission loss is {ivals.A_fs__db} dB.")
-# The mode of propagation is Troposcatter
-# The effective height of the TX is 13.032653298563167 meters.
-# The free space basic transmission loss is 135.97182518111362 dB.
    -
    -
    -

    Area Mode Basic Transmission Loss (CR)

    -
    # define link parameters
-f__mhz = 5000                       # MHz
-h_tx__meter = 10                    # meters, AGL
-h_rx__meter = 5                     # meters, AGL
-N_0 = 301                           # N-Units
-epsilon = 15                        # average ground
-sigma = 0.005                       # average ground
-d__km = 100                         # km
-delta_h__meter = 40                 # meter
-tx_site_criteria = itm.SitingCriteria.Careful
-rx_site_criteria = itm.SitingCriteria.Careful
-climate = itm.Climate.ContinentalTemperate
-pol = itm.Polarization.Horizontal
-
-# define variability parameters
-mdvar = 13
-confidence = 50                     # median
-reliability = 50                    # median
-
-# call ITM
-rtn, A__db, warnings, ivals = itm.ITM_AREA_CR(h_tx__meter, h_rx__meter, 
-    tx_site_criteria, rx_site_criteria, d__km, delta_h__meter, climate, 
-    N_0, f__mhz, pol, epsilon, sigma, mdvar, confidence, reliability)
-
-assert(rtn == 0)                    # no errors
-assert(A__db == 205.7473567880463)  # basic transmission loss, in dB
-assert(warnings == 0)               # no warnings
-
-# can use the intermediate values object to access additional information
-# from the ITM prediction
-print(f"The mode of propagation is {ivals.mode.name}")
-print(f"The effective height of the TX is {ivals.h_e__meter[0]} meters.")
-print(f"The free space basic transmission loss is {ivals.A_fs__db} dB.")
-# The mode of propagation is Troposcatter
-# The effective height of the TX is 13.032653298563167 meters.
-# The free space basic transmission loss is 146.42940008672036 dB.
    - - -
    -
    - -
    - -
    - - - - - \ No newline at end of file diff --git a/models/ITM/cpp.html b/models/ITM/cpp.html index 752fc3b..035d773 100644 --- a/models/ITM/cpp.html +++ b/models/ITM/cpp.html @@ -7,7 +7,7 @@ -NTIA/ITS Propagation Library Wiki - Irregular Terrain Model (ITM) - C++ +ITS Propagation Library Wiki - Irregular Terrain Model (ITM) - C++