Merge pull request #2 from NTIA/dev

Add disclaimers and purge outdated content for P2108

includes/_getting_started.qmd

@@ -3,6 +3,6 @@
 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.
 
 [C++](cpp.qmd){.btn .btn-secondary role="button"}
-[C#/.NET](dotnet.qmd){.btn .btn-secondary disabled role="button"}
-[MATLAB](matlab.qmd){.btn .btn-secondary disabled role="button"}
+[C#/.NET](dotnet.qmd){.btn .btn-secondary role="button"}
+[MATLAB](matlab.qmd){.btn .btn-secondary role="button"}
 [Python](python.qmd){.btn .btn-secondary role="button"}

models/P2108/dotnet.qmd

@@ -8,66 +8,20 @@ title: "ITU-R P.2108 – C#/.NET"
 
 {{< include /includes/_package_install_not_ready.qmd >}}
 
-To begin, install the NuGet package, `P2108`, from the NTIA NuGet repository
-
-![Screenshot of P.2108 NuGet package to install](images/p2108_nuget.jpg)
-
-All of the below code snippets requires the including the following `using` statement.
-
-```csharp
-using ITS.Propagation;
-```
-
 ## Documentation
 
-The `p2108` 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.
+{{< include /includes/_under_construction.qmd >}}
 
 # Examples
 
 ## Height Gain Terminal Correction Model
 
-```csharp
-// define inputs
-double f__ghz = 1;         // GHz
-double h__meter = 1.5;     // meters
-double w_s__meter = 27;    // meters (default value)
-double R__meter = 20;      // meters (Dense urban default value)
-int clutter_type = 6;      // Dense urban
-
-// call clutter model
-int rtn = P2108.HeightGainTerminalCorrectionModel(f__ghz, h__meter, w_s__meter, R__meter, clutter_type, out double A_h__db);
-// A_h__db = 8.76939426153355
-
-// can also use clutter type enum
-var clutterType = P2108.ClutterType.DenseUrban;
-
-// call clutter model
-rtn = P2108.HeightGainTerminalCorrectionModel(f__ghz, h__meter, w_s__meter, R__meter, (int)clutterType, out double A_h__db2);
-// A_h__db = 8.76939426153355
-```
+{{< include /includes/_under_construction.qmd >}}
 
 ## Terrestrial Statistical Model
 
-```csharp
-// define inputs
-double f__ghz = 3;         // GHz
-double d__km = 0.5;        // km
-double p = 50;             // %
-
-// call clutter model
-int rtn = P2108.TerrestrialStatisticalModel(f__ghz, d__km, p, out double L_ctt__db);
-// L_ctt__db = 26.1007503678334
-```
+{{< include /includes/_under_construction.qmd >}}
 
 ## Aeronautical Statistical Model
 
-```csharp
-// define inputs
-double f__ghz = 15;        // GHz
-double theta__deg = 10;    // degrees
-double p = 50;             // %
-
-// call clutter model
-int rtn = P2108.AeronauticalStatisticalModel(f__ghz, theta__deg, p, out double L_ces__db);
-// L_ces__db = 14.3336860400678
-```
+{{< include /includes/_under_construction.qmd >}}

models/P2108/index.qmd

@@ -44,8 +44,8 @@ This table also provides the integer values mapped to each clutter type in the e
 {{< include /includes/_code_examples.qmd >}}
 
 [C++](cpp.qmd#height-gain-terminal-correction-model){.btn .btn-secondary role="button"}
-[C#/.NET](dotnet.qmd#height-gain-terminal-correction-model){.btn .btn-secondary disabled role="button"}
-[MATLAB](matlab.qmd#height-gain-terminal-correction-model){.btn .btn-secondary disabled role="button"}
+[C#/.NET](dotnet.qmd#height-gain-terminal-correction-model){.btn .btn-secondary role="button"}
+[MATLAB](matlab.qmd#height-gain-terminal-correction-model){.btn .btn-secondary role="button"}
 [Python](python.qmd#height-gain-terminal-correction-model){.btn .btn-secondary role="button"}
 
 ### Terrestrial Statistical Model
@@ -64,8 +64,8 @@ This model calculates an additional loss, $L_{ctt}$, which can be added to the t
 {{< include /includes/_code_examples.qmd >}}
 
 [C++](cpp.qmd#terrestrial-statistical-model){.btn .btn-secondary .btn role="button"}
-[C#/.NET](dotnet.qmd#terrestrial-statistical-model){.btn .btn-secondary .btn disabled role="button"}
-[MATLAB](matlab.qmd#terrestrial-statistical-model){.btn .btn-secondary disabled .btn role="button"}
+[C#/.NET](dotnet.qmd#terrestrial-statistical-model){.btn .btn-secondary .btn role="button"}
+[MATLAB](matlab.qmd#terrestrial-statistical-model){.btn .btn-secondary .btn role="button"}
 [Python](python.qmd#terrestrial-statistical-model){.btn .btn-secondary .btn role="button"}
 
 ### Aeronautical Statistical Model
@@ -86,6 +86,6 @@ The method used to develop this model is described in @p2402-0.
 {{< include /includes/_code_examples.qmd >}}
 
 [C++](cpp.qmd#aeronautical-statistical-model){.btn .btn-secondary .btn role="button"}
-[C#/.NET](dotnet.qmd#aeronautical-statistical-model){.btn .btn-secondary .btn disabled role="button"}
-[MATLAB](matlab.qmd#aeronautical-statistical-model){.btn .btn-secondary .btn disabled role="button"}
+[C#/.NET](dotnet.qmd#aeronautical-statistical-model){.btn .btn-secondary .btn role="button"}
+[MATLAB](matlab.qmd#aeronautical-statistical-model){.btn .btn-secondary .btn role="button"}
 [Python](python.qmd#aeronautical-statistical-model){.btn .btn-secondary .btn role="button"}

models/P2108/matlab.qmd

@@ -10,78 +10,18 @@ title: "ITU-R P.2108 – MATLAB"
 
 ## Documentation
 
-All `p2108` functions are docummented with detailed headers, such as:
-
-```matlab
-% Function AeronauticalStatisticalModel(...)
-%
-% Description: The Earth-space and aeronautical statistical 
-%       clutter loss model as described in Section 3.3.
-%
-% Inputs:
-%   f__ghz : Frequency, in GHz
-%   theta__deg : Elevation angle, in degrees
-%   p : Percentange of locations, in %
-%
-% Outputs:
-%   L_ces__db : Additional loss (clutter loss), in dB
-%   rtn : P2108 return value
-```
+{{< include /includes/_under_construction.qmd >}}
 
 # Examples
 
 ## Height Gain Terminal Correction Model
 
-```matlab
-% define inputs
-f__ghz = 1;         % GHz
-h__meter = 1.5;     % meters
-w_s__meter = 27;    % meters (default value)
-R__meter = 20;      % meters (Dense urban default value)
-clutter_type = 6;   % Dense urban
-
-% call clutter model
-[A_h__db, rtn] = P2108.HeightGainTerminalCorrectionModel(...
-    f__ghz, h__meter, w_s__meter, R__meter, clutter_type)
-% A_h__db = 8.7694
-% rtn = 0
-
-% can also use clutter type enum
-clutter_type = P2108ClutterType.DenseUrban;
-
-% call clutter model
-[A_h__db, rtn] = P2108.HeightGainTerminalCorrectionModel(...
-    f__ghz, h__meter, w_s__meter, R__meter, clutter_type)
-% A_h__db = 8.7694
-% rtn = 0
-```
+{{< include /includes/_under_construction.qmd >}}
 
 ## Terrestrial Statistical Model
 
-```matlab
-% define inputs
-f__ghz = 3;         % GHz
-d__km = 0.5;        % km
-p = 50;             % %
-
-% call clutter model
-[L_ctt__db, rtn] = P2108.TerrestrialStatisticalModel(...
-    f__ghz, d__km, p)
-% L_ctt__db = 26.1008
-% rtn = 0
-```
+{{< include /includes/_under_construction.qmd >}}
 
 ## Aeronautical Statistical Model
 
-```matlab
-% define inputs
-f__ghz = 15;        % GHz
-theta__deg = 10;    % degrees
-p = 50;             % %
-
-% call clutter model
-[L_ces__db, rtn] = P2108.AeronauticalStatisticalModel(...
-    f__ghz, theta__deg, p)
-% L_ces__db = 14.3337
-% rtn = 0
-```
+{{< include /includes/_under_construction.qmd >}}