Fix: Issues flagged by markdownlint

Signed-off-by: Matthew Watkins <[email protected]>

Author: ModeSevenIndustrialSolutions

.pre-commit-config.yaml

@@ -76,7 +76,7 @@ repos:
     rev: acc9d9de6369b76d22cb4167029d2035e8730b98 # frozen: v0.19.1
     hooks:
       - id: gitlint
-        # args: ["-c body-max-line-length=120", "-c title-max-length=120"]
+        args: ["-c body-max-line-length=120", "-c title-max-length=120"]
 
   - repo: https://github.com/openstack/bashate
     rev: 5798d24d571676fc407e81df574c1ef57b520f23 # frozen: 2.1.1
@@ -103,7 +103,7 @@ repos:
         args:
           [
             "-d",
-            "{rules: {line-length: {max: 100}}, ignore-from-file: [.gitignore],}",
+            "{rules: {line-length: {max: 120}}, ignore-from-file: [.gitignore],}",
           ]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit

CHANGELOG.md

@@ -40,7 +40,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.1.2] - 2022-04-01
 
-### Fixes
+### Bug Fixes
 
 - Add missing __init__.py file in src/physrisk/data_objects
 

CONTRIBUTING.md

@@ -4,32 +4,34 @@
 
 To get set up, clone and enter the repo.
 
-```
+```bash
 git clone [email protected]:os-climate/physrisk.git
 cd physrisk
 ```
 
 We recommend using [pdm](https://pdm-project.org/latest/) for a
 consistent working environment. Install via, e.g.:
 
-```
+```bash
 pip install pdm
 ```
 
 For ease of using Jupyter notebooks (e.g. in VS Code) the config can be used:
 
-```
+```bash
 pdm config venv.with_pip True
 ```
 
 The command:
 
-```
+```bash
 pdm install
 ```
 
-will create a virtual environment (typically .venv folder in the project folder) and install the dependencies.
-We recommend that the IDE workspace uses this virtual environment when developing.
+will create a virtual environment (typically .venv folder in the project
+folder) and install the dependencies.
+We recommend that the IDE workspace uses this virtual environment when
+developing.
 
 When adding a package for use in new or improved functionality,
 `pdm add <package-name>`. Or, when adding something helpful for
@@ -48,21 +50,22 @@ checks.
 and enabling automatic formatting via [pre-commit](https://pre-commit.com/)
 is recommended:
 
-```
+```bash
 pre-commit install
 ```
 
 or
 
-```
+```bash
 pre-commit run --all-files
 ```
 
-To ensure compliance with static check tools, developers may wish to run black and isort against modified files.
+To ensure compliance with static check tools, developers may wish to run
+black and isort against modified files.
 
 E.g.,
 
-```
+```bash
 # auto-sort imports
 isort .
 # auto-format code
@@ -71,7 +74,7 @@ black .
 
 Code can then be tested using tox.
 
-```
+```bash
 # run static checks and unit tests
 tox
 # run only tests
@@ -84,17 +87,19 @@ tox -e cov
 
 ## IDE set-up
 
-For those using VS Code, configure tests ('Python: Configure Tests') to use 'pytest'
-to allow running of tests within the IDE.
+For those using VS Code, configure tests ('Python: Configure Tests') to
+use 'pytest' to allow running of tests within the IDE.
 
 ## Releasing
 
-Actions are configured to release to PyPI on pushing a tag. In order to do this:
+Actions are configured to release to PyPI on pushing a tag. In order to
+do this:
 
-- Ensure version in pyproject.toml is updated (will require pull request like any other change)
+- Ensure version in pyproject.toml is updated (will require pull request
+  like any other change)
 - Create new annotated tag and push
 
-```
+```bash
 git tag -a v1.0.0 -m "v1.0.0"
 git push --follow-tags
 ```
@@ -106,21 +111,26 @@ This is a useful clarification of the forking workflow:
 
 ## Project Organization
 
-------------
+---
 
-    ├── LICENSE
-    ├── pdm.lock           <- pdm.lock stating a pinned down software stack as used by pdm.
+```text
+├── LICENSE
+    ├── pdm.lock           <- pdm.lock stating a pinned down software stack
+    │                         as used by pdm.
     ├── README.md          <- The top-level README for developers using this project.
     │
     ├── methodology        <- Contains LaTeX methodology document.
     │    └── literature    <- Literature review.
     │
-    ├── docs               <- A default Sphinx project; see sphinx-doc.org for details.
+    ├── docs               <- A default Sphinx project; see sphinx-doc.org
+    │                         for details.
     │
-    ├── notebooks          <- Jupyter notebooks. These comprise notebooks used for on-boarding
-    │                         hazard data, on-boarding vulnerability models and tutorial.
+    ├── notebooks          <- Jupyter notebooks. These comprise notebooks used
+    │                         for on-boarding hazard data, on-boarding
+    │                         vulnerability models and tutorial.
     │
-    ├── setup.py           <- makes project pip installable (pip install -e .) so src can be imported.
+    ├── setup.py           <- makes project pip installable (pip install -e .)
+    │                         so src can be imported.
     │
     ├── src                <- Source code for use in this project.
     │   └── physrisk       <- physrisk source code.
@@ -131,4 +141,4 @@ This is a useful clarification of the forking workflow:
     │
     └── tox.ini            <- tox file with settings for running tox; see tox.readthedocs.io.
 
---------
+---

README.md

@@ -11,50 +11,78 @@
 
 Physical climate risk calculation engine.
 
-<img src="docs/images/OS-Climate-Logo.png" alt="drawing" width="150"/>
+![OS-Climate Logo](docs/images/OS-Climate-Logo.png)
 
 ## About physrisk
 
-An [OS-Climate](https://os-climate.org) project, physrisk is a library for assessing the physical effects of climate change and thereby the potential benefit of measures to improve resilience.
+An [OS-Climate](https://os-climate.org) project, physrisk is a library for
+assessing the physical effects of climate change and thereby the potential
+benefit of measures to improve resilience.
 
-An introduction and methodology is available [here](https://github.com/os-climate/physrisk/blob/main/methodology/PhysicalRiskMethodology.pdf).
+An introduction and methodology is available in the
+[Physical Risk Methodology document](https://github.com/os-climate/physrisk/blob/main/methodology/PhysicalRiskMethodology.pdf).
 
-Physrisk is primarily designed to run 'bottom-up' calculations that model the impact of climate hazards on large numbers of individual assets (including natural) and operations. These calculations can be used to assess financial risks or socio-economic impacts. To do this physrisk collects:
+Physrisk is primarily designed to run 'bottom-up' calculations that model
+the impact of climate hazards on large numbers of individual assets
+(including natural) and operations. These calculations can be used to assess
+financial risks or socio-economic impacts. To do this physrisk collects:
 
 - hazard indicators and
 - models of vulnerability of assets/operations to hazards.
 
-Hazard indicators are on-boarded from public resources or inferred from climate projections, e.g. from CMIP or CORDEX data sets. Indicators are created from code in the
-[hazard repo](https://github.com/os-climate/hazard) to make calculations as transparent as possible.
+Hazard indicators are on-boarded from public resources or inferred from
+climate projections, e.g. from CMIP or CORDEX data sets. Indicators are
+created from code in the
+[hazard repository](https://github.com/os-climate/hazard) to make
+calculations as transparent as possible.
 
-Physrisk is also designed to be a hosted, e.g. to provide on-demand calculations. [physrisk-api](https://github.com/os-climate/physrisk-api) and [physrisk-ui](https://github.com/os-climate/physrisk-ui) provide an example API and user interface. A [development version of the UI](https://physrisk-ui-physrisk.apps.odh-cl2.apps.os-climate.org) is hosted by OS-Climate.
+Physrisk is also designed to be a hosted, e.g. to provide on-demand
+calculations.
+[physrisk-api](https://github.com/os-climate/physrisk-api) and
+[physrisk-ui](https://github.com/os-climate/physrisk-ui) provide an example
+API and user interface. A
+[development version of the UI](https://physrisk-ui-physrisk.apps.odh-cl2.apps.os-climate.org)
+is hosted by OS-Climate.
 
 ## Using the library
 
-The library can be run locally, although access to the hazard indicator data is needed. The library is installed via:
+The library can be run locally, although access to the hazard indicator data
+is needed. The library is installed via:
 
-```
+```bash
 pip install physrisk-lib
 ```
 
-Hazard indicator data is freely available. Members of the project are able to access OS-Climate S3 buckets. Credentials are available [here](https://console-openshift-console.apps.odh-cl2.apps.os-climate.org/k8s/ns/physrisk/secrets/physrisk-s3-keys). Information about the project is available via the [community-hub](https://github.com/os-climate/OS-Climate-Community-Hub). Non-members are able to download or copy hazard indicator data.
+Hazard indicator data is freely available. Members of the project are able to
+access OS-Climate S3 buckets. Credentials are available from the
+[OS-Climate S3 keys](https://console-openshift-console.apps.odh-cl2.apps.os-climate.org/k8s/ns/physrisk/secrets/physrisk-s3-keys).
+Information about the project is available via the
+[community-hub](https://github.com/os-climate/OS-Climate-Community-Hub).
+Non-members are able to download or copy hazard indicator data.
 
-Hazard indicator data can be downloaded or copied from the 'os-climate-public-data' bucket. A list of the keys to copy is available from
+Hazard indicator data can be downloaded or copied from the
+'os-climate-public-data' bucket. A list of the keys to copy is available from
 <https://os-climate-public-data.s3.amazonaws.com/hazard/keys.txt>
 
-An inventory of the hazard data is maintained [here](https://github.com/os-climate/hazard/blob/main/src/inventories/hazard/inventory.json) (this is used by the physrisk library itself). The [UI hazard viewer](https://physrisk-ui-physrisk.apps.odh-cl2.apps.os-climate.org) is a convenient way to browse data sets.
+An inventory of the hazard data is maintained in the
+[hazard inventory](https://github.com/os-climate/hazard/blob/main/src/inventories/hazard/inventory.json)
+(this is used by the physrisk library itself). The
+[UI hazard viewer](https://physrisk-ui-physrisk.apps.odh-cl2.apps.os-climate.org)
+is a convenient way to browse data sets.
 
-Access to hazard event data requires setting of environment variables specifying the S3 Bucket, for example:
+Access to hazard event data requires setting of environment variables
+specifying the S3 Bucket, for example:
 
-```
+```bash
 OSC_S3_BUCKET=physrisk-hazard-indicators
 OSC_S3_ACCESS_KEY=**********
 OSC_S3_SECRET_KEY=**********
 ```
 
-For use in a Jupyter environment, it is recommended to put the environment variables in a credentials.env file and do, for example:
+For use in a Jupyter environment, it is recommended to put the environment
+variables in a credentials.env file and do, for example:
 
-```
+```python
 from dotenv import load_dotenv
 load_dotenv(dotenv_path=dotenv_path, override=True)
 ```

docs/README.md

@@ -9,4 +9,5 @@ make html
 
 A Read the Docs process builds to: <https://physrisk.readthedocs.io/en/latest/index.html>.
 
-Currently ``requirements-docs.txt`` is used by Read the Docs and requires all physrisk packages in order to generate API correctly.
+Currently ``requirements-docs.txt`` is used by Read the Docs and requires
+all physrisk packages in order to generate API correctly.

methodology/toadapt/README.md

@@ -1 +1,3 @@
+# Materials to Adapt
+
 Various materials to adapt integrate into the documentation.

methodology/toadapt/hazards/README.md

@@ -1,2 +1,5 @@
-These files contain a mixture of hazard information  and details of an ECB stress test study (beyond scope of physrisk).
+# Hazard Information Files
+
+These files contain a mixture of hazard information and details of an ECB
+stress test study (beyond scope of physrisk).
 TODO: separate out hazard part and add to methodology doc.

src/physrisk/data/static/vulnerability/vulnerability_config_README.md

@@ -1,5 +1,7 @@
 # Vulnerability configuration
 
-Vulnerability configuration is generated by a test: `test_generate_all_config`.
+Vulnerability configuration is generated by a test:
+`test_generate_all_config`.
 
-This test writes to a temporary file `candidate_vulnerability_config.csv` that can be copied into `vulnerability.config.csv`.
+This test writes to a temporary file `candidate_vulnerability_config.csv`
+that can be copied into `vulnerability.config.csv`.