From 6dffb6b02a0855b8f5655290cfbec9864f8a77ff Mon Sep 17 00:00:00 2001
From: tk815965 <l.risley@pgr.reading.ac.uk>
Date: Mon, 18 Oct 2021 14:42:57 +0100
Subject: [PATCH] Update README.md

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7ff552b..34b4b16 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,21 @@
-# MTMW12_Assignment3
+**physProps.py**
+This file contains all the physical properties and equations needed in the assignment
 
+**differentiate.py**
+This file contains the 2-point and 3-point differences formulas needed in the assignment.
+
+All the following files require physProps and differentiate to be inported.
+
+**geostrophicWind**
+This runs code to find the 2-point differences for p and then uses this to find an estimate of u.
+Then two plots are produced, the exact values against the numeric, and the errors.
+
+**error_experiment.py**
+This file runs the experiment that show what the order of accuracy of the errors is at y=N/2. 
+The errors are plotted against the interval size, the gradient is found and this is the order.
+
+**geostrophicWind_updated.py**
+This is the same as geostrophicWind.py but updated to use the three-point differences for the end-ppoints.
+
+**errors_experiment_updated.py**
+This is the same as error_experiment.py but updated to investigate the error at y0 and yN for the three-point differences.
\ No newline at end of file
-- 
GitLab