Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix usage of "C#" and ".NET" throughout wiki site #5

Merged
merged 4 commits into from
Nov 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion .github/workflows/quarto-publish.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
on:
pull_request:
branches:
- main
push:
branches:
- main
Expand Down Expand Up @@ -30,7 +33,14 @@ jobs:
python-version: '3.10'
- run: pip install jupyter

- name: Publish to GitHub Pages (and render)
- name: Render Quarto Project
if: ${{ github.event_name == 'pull_request' }}
uses: quarto-dev/quarto-actions/render@v2
with:
to: html

- name: Publish to GitHub Pages
if: ${{ github.event_name == 'push' }}
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# ITS Propagation Library Wiki

[![NTIA/ITS PropLib][proplib-badge]][proplib-link]
[![Site Build and Deploy Status][gh-actions-badge]][gh-actions-link]
[![GitHub Issues][gh-issues-badge]][gh-issues-link]

[gh-actions-badge]: https://github.com/NTIA/propagation-library-wiki/actions/workflows/quarto-publish.yml/badge.svg
[proplib-badge]: https://img.shields.io/badge/PropLib-badge?label=%F0%9F%87%BA%F0%9F%87%B8%20NTIA%2FITS&labelColor=162E51&color=D63E04
[proplib-link]: https://ntia.github.io/propagation-library-wiki
[gh-actions-badge]: https://img.shields.io/github/actions/workflow/status/NTIA/propagation-library-wiki/quarto-publish.yml?branch=main&logo=quarto&label=Render%20%26%20Publish&labelColor=162E51
[gh-actions-link]: https://ntia.github.io/propagation-library-wiki
[gh-issues-badge]: https://img.shields.io/github/issues/NTIA/propagation-library-wiki?logo=github&label=Issues&labelColor=162E51
[gh-issues-link]: https://github.com/NTIA/proplib-template/issues

This repository hosts wiki pages for the suite of softwares comprising the
ITS Propagation Library. The wiki is generated with [Quarto](https://quarto.org/)
Expand Down
2 changes: 1 addition & 1 deletion includes/_getting_started.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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 role="button"}
[.NET](dotnet.qmd){.btn .btn-secondary role="button"}
[MATLAB](matlab.qmd){.btn .btn-secondary role="button"}
[Python](python.qmd){.btn .btn-secondary role="button"}
4 changes: 2 additions & 2 deletions index.qmd
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "ITS Propagation Library Wiki"
date: 2024-06-11
date-modified: 2024-06-11
date-modified: 2024-11-20
---

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++, 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.
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.

## Packages

Expand Down
4 changes: 3 additions & 1 deletion models/ITM/dotnet.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Irregular Terrain Model (ITM) – C#/.NET"
title: "Irregular Terrain Model (ITM) – .NET"
---

{{< include /includes/_under_construction.qmd >}}
Expand All @@ -22,6 +22,8 @@ The `itm` library is packaged to support IntelliSense when developing in Visual

# Examples

The following code examples show how to use C# to call ITM functions from the .NET package.

**Note:** These examples use an artificial terrain profile.

## Point-to-Point Basic Transmission Loss (TLS)
Expand Down
2 changes: 2 additions & 0 deletions models/P2108/cpp.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: "ITU-R P.2108 – C++"
date: 2024-07-09
date-modified: 2024-11-20
---

{{< include /includes/_under_construction.qmd >}}
Expand Down
4 changes: 3 additions & 1 deletion models/P2108/dotnet.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "ITU-R P.2108 – C#/.NET"
title: "Recommendation ITU-R P.2108 – .NET"
---
aromanielloNTIA marked this conversation as resolved.
Show resolved Hide resolved

{{< include /includes/_under_construction.qmd >}}
Expand All @@ -14,6 +14,8 @@ title: "ITU-R P.2108 – C#/.NET"

# Examples

The following code examples show how to use C# to call P.2108 functions from the .NET package.

## Height Gain Terminal Correction Model

{{< include /includes/_under_construction.qmd >}}
Expand Down
10 changes: 5 additions & 5 deletions models/P2108/index.qmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ITU-R P.2108"
title: "Recommendation ITU-R P.2108"
date: 2024-06-28
date-modified: 2024-06-28
date-modified: 2024-11-20
---

Recommendation ITU-R P.2108 _Prediction of clutter loss_ contains three methods for the prediction of clutter loss: the [Height Gain Terminal Correction Model](#height-gain-terminal-correction-model), [Terrestrial Statistical Model](#terrestrial-statistical-model), and [Aeronautical Statistical Model](#aeronautical-statistical-model) [@p2108-1, Sections 3.1-3.3]. This software implements each of the three models.
Expand Down Expand Up @@ -44,7 +44,7 @@ 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 role="button"}
[.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"}

Expand All @@ -64,7 +64,7 @@ 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 role="button"}
[.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"}

Expand All @@ -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 role="button"}
[.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"}
2 changes: 1 addition & 1 deletion models/P2108/matlab.qmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "ITU-R P.2108 – MATLAB"
title: "Recommendation ITU-R P.2108 – MATLAB"
---
aromanielloNTIA marked this conversation as resolved.
Show resolved Hide resolved

{{< include /includes/_under_construction.qmd >}}
Expand Down
4 changes: 2 additions & 2 deletions models/P2108/python.qmd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "ITU-R P.2108 – Python"
title: "Recommendation ITU-R P.2108 – Python"
date: 2024-06-25
date-modified: 2024-06-25
date-modified: 2024-11-20
---

This page details the installation and usage of the Python version of the U.S. Reference Implementation of Recommendation ITU-R P.2108.
Expand Down
Loading