From ed5ea1f9e80b7060e55a93be36a293200173e72f Mon Sep 17 00:00:00 2001
From: cemachelen <h.l.burns@leeds.ac.uk>
Date: Thu, 7 Jul 2022 11:52:18 +0100
Subject: [PATCH] :pencil2: add readme

---
 README.md | 40 +++++++++++++++++++++++++++++++++-------
 1 file changed, 33 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index a0d7175..1e5824d 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,19 @@
+<div align="center">
+<img src="https://github.com/cemac/LIFD_ENV_ML_NOTEBOOKS/blob/main/images/LIFDlogo.png"></a>
+<a href="https://www.cemac.leeds.ac.uk/">
+  <img src="https://github.com/cemac/cemac_generic/blob/master/Images/cemac.png"></a>
+  <br>
+</div>
+
+# Leeds Institute for Fluid Dynamics Machine Learning For Earth Sciences #
+
 # Physics Informed Neural Networks
 
+
+[![GitHub release](https://img.shields.io/github/release/cemac/LIFD_Physics_Informed_Neural_Networks.svg)](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks/releases) [![GitHub top language](https://img.shields.io/github/languages/top/cemac/LIFD_Physics_Informed_Neural_Networks.svg)](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks) [![GitHub issues](https://img.shields.io/github/issues/cemac/LIFD_Physics_Informed_Neural_Networks.svg)](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks/issues) [![GitHub last commit](https://img.shields.io/github/last-commit/cemac/LIFD_Physics_Informed_Neural_Networks.svg)](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks/commits/master) [![GitHub All Releases](https://img.shields.io/github/downloads/cemac/LIFD_Physics_Informed_Neural_Networks/total.svg)](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks/releases) ![GitHub](https://img.shields.io/github/license/cemac/LIFD_Physics_Informed_Neural_Networks.svg)[![DOI](https://zenodo.org/badge/366734586.svg)](https://zenodo.org/badge/latestdoi/366734586)
+
+[![LIFD_Physics_Informed_Neural_Networks](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks/actions/workflows/python-package-conda.yml/badge.svg)](https://github.com/cemac/LIFD_Physics_Informed_Neural_Networks/actions/workflows/python-package-conda.yml)
+
 These set of notebooks explore Physics Informed Neural Networks to explore Partial Differential Equations
 
 This tutorial has been split into 3 tutorials.
@@ -21,6 +35,19 @@ If you want a quick look at the contents inside the notebook before deciding to
 * [PNNs Navier Stokes example](PNNs_NavierStokesEquation_example.pdf)
 * [PNNs Navier Stokes Hidden Fluid Mechanics](PNNs_NavierStokes_HFM.md)
 
+### Quick start
+
+If you're already familiar with git, anaconda and virtual environments the environment you need to create is found in PINN.yml and the code below to install activate and launch the notebook. The .yml file has been tested on the latest linux, macOS and windows operating systems.
+
+```bash
+git clone  --recurse-submodules -j8 git@github.com:cemac/LIFD_Physics_Informed_Neural_Networks.git
+cd LIFD_Physics_Informed_Neural_Networks
+conda env create -f PINN.yml
+conda activate PINN
+jupyter-notebook
+```
+
+
 ## Installation and Requirements
 
 This notebook is designed to run on a laptop with no special hardware required therefore recommended to do a local installation as outlined in the repository [howtorun](../howtorun.md) and [jupyter_notebooks](../jupyter_notebooks.md) sections.
@@ -37,12 +64,11 @@ git submodule update --init --recursive
 
 **If this does not work please clone the [PINNs](https://github.com/maziarraissi/PINNs) repository into your Physics_Informed_Neural_Networks folder on your computer**
 
-### Quick start
 
-If you're already familiar with git, anaconda and virtual environments the environment you need to create is found in CNN.yml and the code below to install activate and launch the notebook
+# Licence information #
 
-```bash
-conda env create -f PINN.yml
-conda activate PINN
-jupyter-notebook
-```
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">LIFD_ENV_ML_NOTEBOOKS</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://cemac.leeds.ac.uk/" property="cc:attributionName" rel="cc:attributionURL">cemac</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
+
+## Acknowledgements
+
+Thanks to Matthew Gaddes for the basis of this tutotial. This tutorial is part of the [LIFD ENV ML NOTEBOOKS](https://github.com/cemac/LIFD_ENV_ML_NOTEBOOKS) please refer to for full acknowledgements.