diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index c7fd555..fe5b0a9 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -1,4 +1,4 @@ -name: documentation +name: docs on: [push, pull_request, workflow_dispatch] @@ -18,7 +18,6 @@ jobs: python-version: '3.10.5' - name: Install dependencies run: | - pip install --upgrade pip pip install -r requirements.txt pip install sphinx furo sphinx-changelog - name: Sphinx build diff --git a/README.md b/README.md index 8783ef7..3b6c20d 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ GitHub Actions: docs - -License: GNU GPL v3 + +License: GPL v3 Code style: black @@ -32,7 +32,7 @@ This method is primarily used to represent terrain for weather forecasting purpo --- -**[Read the documentation here.](https://ray-chew.github.io/spec_appx/index.html)** +**[Read the documentation here](https://ray-chew.github.io/spec_appx/index.html)** --- @@ -47,7 +47,7 @@ See [`requirements.txt`](https://github.com/ray-chew/spec_appx/blob/main/require ### Installation -Make a fork and clone your remote forked repository. +Fork this repository and clone your remote fork. ### Configuration @@ -61,7 +61,7 @@ A simple setup can be found in [`runs.idealised_isosceles`](https://github.com/r python3 ./runs/idealised_isosceles.py ``` -However, the codebase is structured such that the user can easily assemble a run script to define their own experiments. Refer to the documentation for the available APIs. +However, the codebase is structured such that the user can easily assemble a run script to define their own experiments. Refer to the documentation for the [available APIs](https://ray-chew.github.io/spec_appx/api.html). ## License diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst index 34c5973..fc6f7dd 100644 --- a/docs/source/quick_start.rst +++ b/docs/source/quick_start.rst @@ -1,6 +1,6 @@ Quickstart ========== -A quick and dirty guide to using the CSAM codebase. +A quick and dirty guide to using the CSAM codebase Requirements ^^^^^^^^^^^^ @@ -15,7 +15,7 @@ Overview ^^^^^^^^ The CSAM codebase is structured modularly, see :numref:`structure` for a graphical overview. -The package :mod:`wrappers` provides interfaces to the core code components in :mod:`src` and :mod:`vis`. For example, it defines the First and Second Approximation steps in the CSAM algorithm and applies the tapering of the physical data. Refer to the APIs for more details. +The package :mod:`wrappers` provides interfaces to the core code components in :mod:`src` and :mod:`vis`. For example, it defines the First and Second Approximation steps in the CSAM algorithm and applies the tapering of the physical data. Refer to the :doc:`APIs ` for more details. Helper functions and data structures are provided for the processing of user-defined topographies (:mod:`src.var.topo`), grids (:mod:`src.var.grid`), and input parameters (:mod:`src.var.params`). @@ -199,7 +199,7 @@ To reproduce the coarse grid study (*Coarse Delaunay triangulation (approximatel run_case = "R2B4" -2. Execute the run script :mod:`runs.delaunay_runs`. Make sure to import the correct user-defined input file: +2. Make sure to import the correct user-defined input file. Then execute the run script :mod:`runs.delaunay_runs`: .. code-block:: console diff --git a/src/utils.py b/src/utils.py index 98fc7ec..4084165 100644 --- a/src/utils.py +++ b/src/utils.py @@ -448,8 +448,8 @@ def get_lat_lon_segments( number of data points in the padded region, by default 0 topo_mask : array-like, optional tapering mask, by default None - mask : _type_, optional - mask to select for data points inside the non-quadrilateral grid cell, by default None + mask : array-like, optional + 2D Boolean mask to select for data points inside the non-quadrilateral grid cell, by default None load_topo : bool, optional explicitly replaces the topography attribute in the cell ``cell.topo`` with the data given in ``topo``, by default False """