Proofreading

.github/workflows/gh-pages.yml

@@ -18,6 +18,7 @@ jobs:
       - name: Dependencies
         run: |
           if [ -f docs/requirements.txt ]; then pip install -r docs/requirements.txt; fi
+          if [ -f pyproject.toml ]; then pip install ".[docs]"; fi
       - name: Build Jupyter Book
         run: |
           jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml

.gitignore

@@ -91,4 +91,4 @@ _build/
 # python-dotenv
 .env
 
-/data
+/data

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-json
+      - id: detect-aws-credentials
+        args: [--allow-missing-credentials]
+      - id: detect-private-key
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint
+        name: Markdownlint
+        files: \.(md|mdown|markdown)$
+        args: [
+            "--disable=MD013", # line-length
+            "--disable=MD033", # no-inline-html
+          ]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+      - id: codespell
+        name: codespell
+        description: Checks for common misspellings in text files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.1
+    hooks:
+      - id: ruff
+        types_or: [python, pyi, jupyter]
+        args: [--fix]
+      - id: ruff-format
+        types_or: [python, pyi, jupyter]

README.md

@@ -1,9 +1,7 @@
 # Development Data Partnership Heatwaves
 
-> A partnership between international organizations and companies, created to facilitate the use of third-party data in research and international development.
-
-Since the Partnership's domain (datapartnership.org) is registered to [GitHub Pages](https://pages.github.com), we can create project pages under the same domain.
+g
 
 ## License
 
-The `heatwaves` repository is licensed under the **World Bank Master Community License Agreement**.
+This projects is licensed under the [**Mozilla Public License**](https://opensource.org/license/mpl-2-0/) - see the [LICENSE](LICENSE) file for details.

environment.yml → notebooks/environment.yml

@@ -8,4 +8,4 @@ dependencies:
   - netCDF4
   - shapely
   - rioxarray
-  - xarray
+  - xarray