Skip to content

Commit

Permalink
final readme edits
Browse files Browse the repository at this point in the history
  • Loading branch information
wkozmaNTIA committed Oct 15, 2020
1 parent f9c213f commit af628e3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 20 deletions.
16 changes: 4 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
# ITS Irregular Terrain Model (ITM) #

This code repository contains the ITS Irregular Terrain Model (ITM). ITM predicts terrestrial radiowave propagation for frequencies between 20 MHz and 20 GHz based on electromagnetic theory and empirical models developed by Anita Longley and Phil Rice. Specifically, ITM predicts attenuation of a radio signal for paths greater than 1 km as a function of distance, terminal heights, meteorological conditions, terrain effects, and the variability of the signal in time and in space. ITM predictions also include free space loss, diffraction, and troposcatter.
This code repository contains the ITS Irregular Terrain Model (ITM). ITM predicts terrestrial radiowave propagation for frequencies between 20 MHz and 20 GHz based on electromagnetic theory and empirical models developed by Anita Longley and Phil Rice. Propagation mechanisms considered include free space loss, diffraction, and troposcatter. Specifically, ITM predicts attenuation as a function of distance (greater than 1 km), terminal heights, meteorological conditions, terrain effects, and the variability of the signal in time and in space.

**Note**: Verion 1.3 of this code base is functionally identical to version 1.2.2 of the FORTRAN source, which has been archived [here](https://github.com/NTIA/itm-longley-rice). ITS plans to apply all future ITM updates to this C++ code base.

## Quick Start ##

Users of ITM have two options to immediately begin using ITM.
Users of ITM have two options to immediately begin using ITM:

### Precompiled DLLs ###
1. The ITM software is made available to the user as a precombiled DLL in the [Release](https://github.com/NTIA/itm/releases) page. A user can add this DLL to their own software project as a dependency and call ITM through its function definitions. Additionally, a C#/.NET software wrapper is provided. Distribution and updates of this wrapper code are provided through the published [NuGet package](https://github.com/NTIA/itm/packages).

The ITM software is made available to the user as a precombiled DLL in the [Release](https://github.com/NTIA/itm/releases) page. A user can add this DLL to their own software project as a dependency and call ITM through its function definitions.

Additionally, a C#/.NET software wrapper is provided. Distribution and updates of this wrapper code are provided through the published [NuGet package](https://github.com/NTIA/itm/packages).

### Commandline Driver ###

A supporting commandline driver is also included in this repository, with its own corresponding [readme](cmdREADME.md). This tool allows a user to call ITM without any programming required through the use of ASCII input/output files.

### Example Values ###
2. A supporting command-line driver is also included in this repository, with its own corresponding [readme](cmdREADME.md). This tool allows a user to call ITM without any programming required through the use of ASCII input/output files.

A select set of example inputs and outputs are provide for testing purposes. This is not a comprehensive validation test set. For ITM in Point-to-Point Prediction Mode, [p2p.csv](p2p.csv) defines the set of inputs and outputs with [pfls.csv](pfls.csv) containing the corresponding set of terrain profiles. For Area Prediction Mode, inputs and outputs are defined in [area.csv](area.csv).

Expand Down
16 changes: 8 additions & 8 deletions cmdREADME.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# ITM Commandline Driver #
# ITM Command-line Driver #

This readme explains the use of the ITM commandline driver. This is a supplemental software tool to allow a user to call the ITM DLL from the commandline with inputs specified in supporting file formats.
This readme explains the use of the ITM command-line driver. This is a supplemental software tool to allow a user to call the ITM DLL from the command-line with inputs specified in supporting file formats.

## Input Files ##

Inputs to the commandline 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. The driver will automatically detect whether ITM should be called specifying variability in time/location/situation or confidence/reliability based on the input parameters specified.
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. The driver will automatically detect whether ITM should be called specifying variability in time/location/situation or confidence/reliability based on the input parameters specified.

## Output Files ##

After parsing the inputs and calling ITM, the commandline driver will generate an output report file containing the results. This results file contains inputs params, output params, and human-readable supporting documentation.
After parsing the inputs and calling ITM, the command-line driver will generate an output report file containing the results. This results file contains inputs params, output params, and human-readable supporting documentation.

## Execution ##

Executing the ITM commandline driver requires specifying input arguments, defined in the below table:
Executing the ITM command-line driver requires specifying input arguments, defined in the below table:

| Flag | Type | Required? | Description |
|---------|--------|-----------|--------------|
Expand All @@ -22,7 +22,7 @@ Executing the ITM commandline driver requires specifying input arguments, define
| `-t` | string | False | File containing terrain information in PFL format. Only needed if using point-to-point mode |
| `-dbg` | | False | If flag is specified, the intermediate data structure values will be written to the output file |

Input arguments are not case sensitive and do not have to be specified in a certain order. A generic example of calling the ITM commandline driver is:
Input arguments are not case sensitive and do not have to be specified in a certain order. A generic example of calling the ITM command-line driver is:

```
ITMDrvr.exe -i <input_file> -t <terrain_file> -o <output_file> -mode P2P
Expand All @@ -39,9 +39,9 @@ ITMDrvr.exe -i <input_file> -t <terrain_file> -o <output_file> -mode P2P
| [`i_areacr.txt`](/cmd_examples/i_areacr.txt) | | [`o_areacr.txt`](/cmd_examples/o_areacr.txt) | `-i i_areacr.txt -o i_areacr.txt -mode AREA -dbg` |
| [`i_areacr_tbl.txt`](/cmd_examples/i_areacr_tbl.txt) | | [`o_areacr_tbl.txt`](/cmd_examples/o_areacr_tbl.txt) | `-i i_areacr_tbl.txt -o o_areacr_tbl.txt -mode AREA` |

## Commandline Driver Errors ##
## Command-line Driver Errors ##

In addition to the ITM DLL [errors](ERRORS_AND_WARNINGS.md), the ITM commandline driver defines the following list of return codes.
In addition to the ITM DLL [errors](ERRORS_AND_WARNINGS.md), the ITM command-line driver defines the following list of return codes.

### General Errors ###

Expand Down

0 comments on commit af628e3

Please sign in to comment.