develop - feature/md

.gitattributes

@@ -0,0 +1 @@
+*.ipynb filter=nbstripout

.github/workflows/deploy.yml

@@ -37,12 +37,14 @@ jobs:
           node-version: 18.x
       - name: Install Jupyter Book (via myst)
         run: npm install -g jupyter-book
+        working-directory: handbook
       - name: Build HTML Assets
         run: jupyter-book build --html
+        working-directory: handbook
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: './_build/html'
+          path: './handbook/_build/html'
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

.gitignore

@@ -1,5 +1,6 @@
 handbook/data
 handbook/outputs
-
+**/.ipynb_checkpoints/
+**/.DS_Store
 # MyST build outputs
 _build

README.md

@@ -4,21 +4,30 @@
   </picture>
 </p>
 
-# ECMWF - Probability of Fire (POF) Model Pipeline
+# Getting started
 
-This repository contains three main scripts representing the end-to-end workflow for generating, training, and forecasting Probability of Fire (POF) using environmental and human
-datasets. The model framework is based around the operation Sparky-PoF system used by ECMWF.
+In this book, we will show how you can create your own version of the Probability of Fire (PoF) system. A pof in a box!
 
-Building the environment
+Before you begin, please note that the workflow presented here is not intended to reproduce the exact operational system currently running at ECMWF. Instead, it provides a simplified sequence of steps designed to help you get started.
+The notebook can only be used with past forecasts—it will generate a tool that allows you to explore and analyse previous forecast data.
+That said, we believe this provides a valuable starting point: a complete, working system built entirely from data that are publicly available through the Climate Data Store (CDS) or accessible via temporary data repositories linked within this notebook.
 
-conda env create -f environment.yml
-conda activate POF_IN_A_BOX
 
-Building the Jupyter Book
+<!-- ![](./PICS/PoF-in-a-box.png) -->
+<p class="credits">CC BY-NC-SA</p>
 
+
+## Building the environment
+```
+conda env create -f environment.yml
+conda activate POF_IN_A_BOX
+```
+## Building the Jupyter Book
+```
 rm -rf _build
 jupyter-book build 
-
-Visualising the book locally.
-
-jupyter-book start
+```
+## Visualising the book locally.
+```
+jupyter-book start
+```

bootstrap.sh

@@ -0,0 +1,11 @@
+mkdir -p handbook/data/CLIMATE
+set -x
+for f in 10U 10V D2M T2M WS;do
+    curl -u ecbox:1hHfYAwUtuzVbSXFHaDVlzNrKDttMwT2RBA0L95Cvr32pgzpsWAoybmjTgJkgeRpcyz3NybnWfd31GWdmOTQBBDXkSRVKTvXGoQkXEXMVPnErYNnQ8V https://sites.ecmwf.int/ecbox/POF_IN_A_BOX/s/dav/data/${f}_2003_01.nc --output handbook/data/${f}_2003_01.nc
+done
+for f in DFMC LFMC FUEL;do
+    curl -u ecbox:1hHfYAwUtuzVbSXFHaDVlzNrKDttMwT2RBA0L95Cvr32pgzpsWAoybmjTgJkgeRpcyz3NybnWfd31GWdmOTQBBDXkSRVKTvXGoQkXEXMVPnErYNnQ8V https://sites.ecmwf.int/ecbox/POF_IN_A_BOX/s/dav/data/${f}_MAP_2003_01_R.nc --output handbook/data/${f}_2003_01_R.nc
+done
+for f in POP_2020.nc_2 road_density_2015_c.nc_2 landcover_2015_c.nc_2;do
+    curl -u ecbox:1hHfYAwUtuzVbSXFHaDVlzNrKDttMwT2RBA0L95Cvr32pgzpsWAoybmjTgJkgeRpcyz3NybnWfd31GWdmOTQBBDXkSRVKTvXGoQkXEXMVPnErYNnQ8V https://sites.ecmwf.int/ecbox/POF_IN_A_BOX/s/dav/data/CLIMATE/${f} --output handbook/data/CLIMATE/${f}
+done

bootstrap_ecmwf.sh

@@ -0,0 +1,3 @@
+ln -sf /perm/maca/POF_IN_A_BOX_data handbook/data
+
+

environment.yml

@@ -7,6 +7,7 @@ dependencies:
 - xarray
 - netcdf4
 - cdsapi
+- cartopy
 - numpy
 - joblib
 - matplotlib