p2001

MATLAB/Octave Implementation of Recommendation ITU-R P.2001

https://github.com/eeveetza/p2001

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

MATLAB/Octave Implementation of Recommendation ITU-R P.2001

Basic Info
  • Host: GitHub
  • Owner: eeveetza
  • License: other
  • Language: MATLAB
  • Default Branch: main
  • Size: 39 MB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 3
Created over 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

MATLAB/Octave Implementation of Recommendation ITU-R P.2001

DOI

This code repository contains a MATLAB/Octave software implementation of Recommendation ITU-R P.2001-4 with a general purpose wide-range terrestrial propagation model in the frequency range 30 MHz to 50 GHz.

This version of the code corresponds to the reference version approved by ITU-R Working Party 3M and published on ITU-R SG 3 Software, Data, and Validation Web Page as digital supplement to Recommendation ITU-R P.2001.

The following table describes the structure of the folder ./matlab/ containing the MATLAB/Octave implementation of Recommendation ITU-R P.2001.

| File/Folder | Description | |----------------------------|---------------------------------------------------------------------| |tl_p2001.m | MATLAB function implementing Recommendation ITU-R P.2001-4 |
|initiate_digital_maps.m| MATLAB script that processes the ITU-R maps and generates the necessary functions. It needs to be run prior to using this software implementation. For details, see Integrating ITU Digital Products. |
|validate_p2001.m | MATLAB scripts used to validate this implementation using a set of test terrain profiles provided in ./validation_examples/ |
|./validation_examples/ | Folder containing validation examples for Recommendation ITU-R P.2001-4 | |./validation_results/ | Folder containing the results of the validation tests using tl_p2001.m on the terrain profiles that corespond to the profiles defined in ./validation_examples/ | |./private/ | Folder containing the functions called by tl_2001.m and validate_p2001*.m|

Integrating ITU Digital Products

This software uses ITU digital products that are integral part of Recommendations. These products must not be reproduced or distributed without explicit written permission from the ITU.

Setup Instructions

  1. Download and extract the required maps to ./private/maps:
  • From ITU-R P.2001-4:
    • DN_Median.txt
    • DN_SubSlope.txt
    • DN_SupSlope.txt
    • dndz_01.txt
    • Esarain_Mt_v5.txt
    • Esarain_Pr6_v5.txt
    • Esarain_Beta_v5.txt
    • FoEs0.1.txt
    • FoEs01.txt
    • FoEs10.txt
    • FoEs50.txt
    • h0.txt
    • surfwv_50_fixed.txt
    • TropoClim.txt
  1. Run the script initiate_digital_maps.m

Notes

  • Ensure all files are placed in ./private/maps before running the script.
  • The script processes the maps, which are critical for the software’s functionality.
  • The resulting *.m files to for retrieving and interpolating data from from the maps.are placed in the folder ./private.

Function Call

~~~ p2001 = tl_p2001(d, h, z, GHz, Tpc, Phire, Phirn, Phite, Phitn, Hrg, Htg, Grx, Gtx, FlagVP); ~~~

Required input arguments of function tl_p2001

| Variable | Type | Units | Limits | Description | |-------------------|--------|-------|--------------|--------------| | d | array double | km | 0 < max(d) ≤ ~1000 | Terrain profile distances (in the ascending order from the transmitter)| | h | array double | m (asl) | | Terrain profile heights | | z | array int | | 1 - Sea, 3 - Coastal Land, 4 - Inland | Zone code | | GHz | scalar double | GHz | 0.3 ≤ GHz ≤ 50 | Frequency | | Tpc | scalar double | % | 0 < Tpc < 100 | Percentage of time (average year) for which the predicted basic transmission loss is not exceeded | | Phire | scalar double | deg | -180 ≤ Phire ≤ 180 | Receiver longitude, positive to east | | Phirn | scalar double | deg | -90 ≤ Phirn ≤ 90 | Receiver latitude, positive to north | | Phite | scalar double | deg | -180 ≤ Phite ≤ 180 | Transmitter longitude, positive to east | | Phitn | scalar double | deg | -90 ≤ Phitn ≤ 90 | Transmitter latitude, positive to north | | Hrg | scalar double | m | 0 < hrg < ~8000 | Receiving antenna height above ground | | Htg | scalar double | m | 0 < htg < ~8000 | Transmitting antenna height above ground | | Grg | scalar double | dBi | | Receiving antenna gain in the direction of the ray to the transmitting antenna | | Gtg | scalar double | dBi | | Transmitting antenna gain in the direction of the ray to the receiving antenna | | flagVP | scalar int | | 1, 0 | Signal polarisation: 1 - vertical, 0 - horizontal |

Outputs

The output is a structure with 122 fields (described in detail in tl_p2001.m) containing intermediate and final results, including the following basic transmission losses:

| Variable | Type | Units | Description | |------------|--------|-------|-------------| | Lb | double | dB | Basic transmission loss not exceeded Tpc % time | | Lbfs | double | dB |Free-space basic transmission loss | | Ld | double | dB | Diffraction loss | | Lba | double | dB | Basic transmission loss associated with anomalous propagation | | Lbs | double | dB | Troposcatter basic transmission loss | | Lbe1, Lbe2 | double | dB | Sporadic-E basic transmission loss for 1- and 2-hop paths, respectively | | ... | | | ... |

Software Versions

The code was tested and runs on: * MATLAB versions 2017a and 2020a * Octave version 6.1.0

References

Owner

  • Name: Ivica Stevanovic
  • Login: eeveetza
  • Kind: user
  • Location: Switzerland
  • Company: Swiss Federal Office of Communications OFCOM

Citation (CITATION.cff)

cff-version: 1.2.0
title: 'MATLAB/Octave Implementation of Recommendation ITU-R P.2001-4'
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ivica
    family-names: Stevanovic
    name-suffix: 
    email: 
    affiliation: Swiss Federal Office of Communications
    orcid: 'https://orcid.org/0000-0002-5032-1844'
doi: 10.5281/zenodo.6141608
url: https://github.com/eeveetza/p2001
version: 4.1.1

GitHub Events

Total
  • Watch event: 2
  • Delete event: 2
  • Push event: 1
  • Fork event: 1
  • Create event: 1
Last Year
  • Watch event: 2
  • Delete event: 2
  • Push event: 1
  • Fork event: 1
  • Create event: 1