Update readmes (#276)

Update readmes
openclimatefix · Feb 27, 2024 · 8b90318 · 8b90318
1 parent 5dfcd02
commit 8b90318
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 83 deletions.
diff --git a/README.md b/README.md
@@ -27,35 +27,44 @@ optionally `.transform.numpy`.
 loading the config file, data, selecting and transforming data, and returning
 the numpy data to the PyTorch dataloader.
 
-Modules have their own README's as well to go into further detail.
+Modules have their own README's as well to go into further detail. This is part of a `tree` showing the general repo structure.
 
 ```
 .
 └── ocf_datapipes/
     ├── batch/
-    │   └── fake
+    │   ├── fake/
     ├── config/
-    │   └── convert/
-    │       └── numpy/
-    │           └── batch
-    ├── experimental
-    ├── fake
+    ├── convert/
+    │   ├── numpy/
+    │   ├── numpy_batch/
+    ├── experimental/
     ├── load/
-    │   ├── gsp
-    │   ├── nwp
-    │   └── pv
-    ├── production
-    ├── select
-    ├── training
-    │   ├── datamodules
+    │   ├── gsp/
+    │   ├── nwp/
+    │   ├── pv/
+    │   ├── satellite.py
+    │   ├── sensor/
+    │   ├── topographic.py
+    │   └── wind/
+    ├── production/
+    ├── select/
+    ├── training/
+    │   ├── common.py
+    │   ├── example/
+    │   ├── metnet/
+    │   ├── pseudo_irradience.py
+    │   ├── pvnet.py
+    │   ├── pvnet_site.py
+    │   └── windnet.py
     ├── transform/
-    │   ├── numpy/
-    │   │   └── batch
+    │   ├── numpy_batch/
     │   └── xarray/
-    │       └── pv
     ├── utils/
-    │   └── split
-    └── validation
+    │   ├── gsp_shape/
+    │   ├── split/
+    ├── validation/
+    └── visualization/
 ```
 
 ## Adding a new DataPipe

diff --git a/ocf_datapipes/training/example/README.md b/ocf_datapipes/training/example/README.md
@@ -4,7 +4,7 @@ These are example datapipes using the `ocf_datapipes` library
 
 ## Simple PV
 
-`simple_pv.py` has a training pipeline for just loading PV data.
+[`simple_pv.py`](simple_pv.py) has a training pipeline for just loading PV data.
 
 The location is chosen using the PV data, PV location data is made.
 Then a time is chosen, and PV examples are made.
@@ -22,55 +22,9 @@ These examples are then made into batches.
       F[PV batch];
 ```
 
+## PV and NWP Pipeline
 
-## GSP, PV, Satellite, and NWP Pipeline
-
-`gsp_pv_satellite_nwp.py` is a training pipeline for loading GSP, PV, and Satellite and NWP.
-
-The location is chosen using the center of the GSP location and using GSP timestamps for forecast
-time t0. Then a time is chosen, and PV, Satellite and NWP examples are made.
-
-```mermaid
-graph TD
-    A1([Load PV])
-    A2([Load GSP]) --> B
-    B[Select Location]
-    A3([Load NWP])
-    A4([Load Satellite])
-    A1 --> C1
-    A2 --> C2
-    C1[PV location]
-    C2[GSP location]
-    C3[NWP location]
-    C4[Satellite location]
-    B --> C1 --> D1
-    B --> C2 --> D1
-    B --> C3 --> D1
-    B --> C4 --> D1
-    A3 --> C3
-    A4 --> C4
-    D1[Select Joint Time Periods] --> D2
-    D2[Select T0]
-    C1 --> E1
-    C2 --> E2
-    D2-->  E1[PV Time and location]
-    D2 --> E2[GSP Time and location]
-    D2 --> E3[NWP Time and location]
-    D2 --> E4[Satellite Time and location]
-    C3 --> E3
-    C4 --> E4
-    E1 --> F1[PV Batch] --> G
-    E2 --> F2[GSP Batch] --> G
-    E3 --> F3[NWP Batch] --> G
-    E4 --> F4[Satelite Batch] --> G
-    G[Example]
-
-```
-
-
-## PVn and NWP Pipeline
-
-`pv_nwp.py` is a training pipeline for loading NWP and PV data.
+[`pv_nwp.py`](pv_nwp.py) is a training pipeline for loading NWP and PV data.
 
 The location is chosen using the PV data, PV and NWP location data is made.
 Then a time is chosen, and PV and NWP examples are made.
@@ -98,41 +52,46 @@ These examples are then made into batches and put together into one Batch.
       G[Batch];
 ```
 
+## GSP, PV, Satellite, and NWP Pipeline
 
-## PV, Satellite and NWP Pipeline
-
-`pv_satellite_nwp.py` is a training pipeline for loading NWP,PV, and Satellite.
+[`gsp_pv_nwp_satellite.py`](gsp_pv_nwp_satellite.py) is a training pipeline for loading GSP, PV, and Satellite and NWP.
 
-The location is chosen using the center of the GSP location.
-Then a time is chosen, and PV, Satellite and NWP examples are made.
+The location is chosen using the center of the GSP location and using GSP timestamps for forecast
+time t0. Then a time is chosen, and PV, Satellite and NWP examples are made.
 
 ```mermaid
 graph TD
     A1([Load PV])
-    A2([Load NWP])
+    A2([Load GSP]) --> B
     B[Select Location]
-    A3([Load Satellite])
+    A3([Load NWP])
+    A4([Load Satellite])
     A1 --> C1
     A2 --> C2
-    A1 --> B
     C1[PV location]
-    C2[NWP location]
-    C3[Satellite location]
+    C2[GSP location]
+    C3[NWP location]
+    C4[Satellite location]
     B --> C1 --> D1
     B --> C2 --> D1
     B --> C3 --> D1
+    B --> C4 --> D1
     A3 --> C3
+    A4 --> C4
     D1[Select Joint Time Periods] --> D2
     D2[Select T0]
     C1 --> E1
     C2 --> E2
-    D2 --> E1[PV Time and location]
-    D2 --> E2[NWP Time and location]
-    D2 --> E3[Satellite Time and location]
+    D2-->  E1[PV Time and location]
+    D2 --> E2[GSP Time and location]
+    D2 --> E3[NWP Time and location]
+    D2 --> E4[Satellite Time and location]
     C3 --> E3
+    C4 --> E4
     E1 --> F1[PV Batch] --> G
-    E2 --> F2[NWP Batch] --> G
-    E3 --> F3[Satelite Batch] --> G
+    E2 --> F2[GSP Batch] --> G
+    E3 --> F3[NWP Batch] --> G
+    E4 --> F4[Satelite Batch] --> G
     G[Example]
 
 ```