diff --git a/includes/_pypi_distribution.qmd b/includes/_pypi_distribution.qmd deleted file mode 100644 index f7bc48c..0000000 --- a/includes/_pypi_distribution.qmd +++ /dev/null @@ -1,5 +0,0 @@ -This Python package is distributed through the -[Python Package Index (PyPI)](https://pypi.org/). All ITS PropLib Python -packages required a [currently-supported](https://devguide.python.org/versions/) -version of Python. Run the following command to install the package, and any required dependencies, into your Python environment: - diff --git a/includes/_cpp_documentation_block.qmd b/includes/cpp/_documentation.qmd similarity index 100% rename from includes/_cpp_documentation_block.qmd rename to includes/cpp/_documentation.qmd diff --git a/includes/_py_documentation_block.qmd b/includes/python/_documentation.qmd similarity index 100% rename from includes/_py_documentation_block.qmd rename to includes/python/_documentation.qmd diff --git a/includes/python/_getting_started.qmd b/includes/python/_getting_started.qmd new file mode 100644 index 0000000..3a095cf --- /dev/null +++ b/includes/python/_getting_started.qmd @@ -0,0 +1,12 @@ +## Getting Started + +All ITS PropLib Python packages require a +[currently-supported](https://devguide.python.org/versions/) +version of Python. You may choose to use a tool such as +[pyenv](https://github.com/pyenv/pyenv) or +[conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) +to manage multiple Python versions on your machine. Additionally, +you may choose to set up a virtual environment for your project, +using conda or a tool such as [`venv`](https://docs.python.org/3/library/venv.html). +Installation instructions assume that you have a supported version of Python installed, +and that you're working from the desired Python environment. \ No newline at end of file diff --git a/includes/python/_uninstallation.qmd b/includes/python/_uninstallation.qmd new file mode 100644 index 0000000..e632bb8 --- /dev/null +++ b/includes/python/_uninstallation.qmd @@ -0,0 +1,4 @@ +### Uninstallation + +Uninstalling this Python package is also simple. Run the following +command in your Python environment. diff --git a/models/P2108/cpp.qmd b/models/P2108/cpp.qmd index 21d397d..f88ea7a 100644 --- a/models/P2108/cpp.qmd +++ b/models/P2108/cpp.qmd @@ -1,7 +1,7 @@ --- title: "Recommendation ITU-R P.2108 – C++" date: 2024-07-09 -date-modified: 2024-11-21 +date-modified: 2024-12-03 --- {{< include /includes/_under_construction.qmd >}} @@ -28,7 +28,7 @@ using namespace ITS::ITU::PSeries:P2108; // Optional: makes later code more con This library has no external C++ dependencies. -{{< include /includes/_cpp_documentation_block.qmd >}} +{{< include /includes/cpp/_documentation.qmd >}} [Docs](https://ntia.github.io/p2108){.btn .btn-secondary .btn role="button"} diff --git a/models/P2108/dotnet.qmd b/models/P2108/dotnet.qmd index 77d19d0..a7b1d66 100644 --- a/models/P2108/dotnet.qmd +++ b/models/P2108/dotnet.qmd @@ -2,7 +2,9 @@ title: "Recommendation ITU-R P.2108 – .NET" --- -{{< include /includes/_under_construction.qmd >}} +This page details the installation and usage of the .NET version of Recommendation ITU-R P.2108. + +{{< include /includes/_link_to_model_home.qmd >}} ## Getting Started diff --git a/models/P2108/python.qmd b/models/P2108/python.qmd index b9a8353..191f749 100644 --- a/models/P2108/python.qmd +++ b/models/P2108/python.qmd @@ -8,22 +8,32 @@ This page details the installation and usage of the Python version of the PropLi {{< include /includes/_link_to_model_home.qmd >}} -## Installation +{{< include /includes/python/_getting_started.qmd >}} -{{< include /includes/_pypi_distribution.qmd >}} +### Installation + +This Python package is distributed through the +[Python Package Index (PyPI)](https://pypi.org/project/proplib-p2108). +Run the following command to install the package, and any required dependencies, into your Python environment. ```default pip install proplib-p2108 ``` -The following code snippet shows how to import the package and check the installed version: +The following code snippet shows how to import the package and check the installed version. ```python from ITS.ITU.PSeries import P2108 print(P2108.__version__) ``` -{{< include /includes/_py_documentation_block.qmd >}} +{{< include /includes/python/_uninstallation.qmd >}} + +```default +pip uninstall proplib-p2108 +``` + +{{< include /includes/python/_documentation.qmd >}} ```python help(P2108.TerrestrialStatisticalModel)