Merge pull request #564 from EPIC-model/manual

Update webpage
EPIC-model · Jun 29, 2024 · bcc4e10 · bcc4e10
2 parents b18610a + 658a357
commit bcc4e10
Show file tree

Hide file tree

Showing 7 changed files with 214 additions and 39 deletions.
diff --git a/docs/about.html b/docs/about.html
diff --git a/docs/gallery.html b/docs/gallery.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+<title>Elliptical Parcel-In-Cell</title>
+
+<link rel="stylesheet" type="text/css" href="index.css">
+
+</head>
+
+<body>
+
+<div class="topnav">
+  <a href="index">Home</a>
+  <a class="active" href="gallery">Gallery</a>
+  <a href="help">Need Help</a>
+</div>
+
+
+<h1>Straka density test case </h1>
+
+<video style="padding-left:20px" width="960px" height="540px" autoplay muted loop>
+<source src="videos/hybrid_straka.mp4" type="video/mp4">
+Your browser does not support the video tag.
+</video>
+
+<h1>Robert warm bubble test case</h1>
+
+<video style="padding-left:20px" width="540px" height="960px" autoplay muted loop>
+<source src="videos/hybrid_robert.mp4" type="video/mp4">
+Your browser does not support the video tag.
+</video>
+
+</body>
diff --git a/docs/help.html b/docs/help.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+
+<title>Elliptical Parcel-In-Cell</title>
+
+<link rel="stylesheet" type="text/css" href="index.css">
+
+</head>
+
+<body>
+
+<div class="topnav">
+  <a href="index">Home</a>
+  <a href="gallery">Gallery</a>
+  <a class="active" href="help">Need Help</a>
+</div>
+
+<h1 style="padding-bottom: 0px">EPIC documentation</h1>
+
+<p class="regular-text">The <a href="https://epic-model.github.io/epic/html/intro.html">EPIC manual</a> contains
+information about the model. Note that this documentation is still work in progress.</p>
+
+<h1 style="padding-bottom: 0px">Get Help</h1>
+
+<p class="regular-text">
+In order to get help, do not hesitate to post an issue in the
+<a href="https://github.com/EPIC-model/epic" target="_blank">EPIC GitHub repository</a>.
+
+</body>
diff --git a/docs/index.css b/docs/index.css
@@ -0,0 +1,57 @@
+body{
+    margin: 0px;
+}
+
+h1{
+/*     background: linear-gradient(to right, darkblue, royalblue, lightblue, white); */
+/*     background-repeat: no repeat; */
+/*     background-attachment: fixed; */
+/*     color: white; */
+    padding: 20px;
+    font-family: Arial, Helvetica, sans-serif;
+}
+
+
+
+
+/* Navigation bar generated with the help of https://www.w3schools.com/css/css_navbar.asp (visited 28 June 2024) */
+.topnav {
+    background: linear-gradient(to left, black, navy, royalblue, navy, black);
+    background-repeat: no repeat;
+    background-attachment: fixed;
+    overflow: hidden;
+    position: sticky;
+    top: 0;
+}
+
+.topnav a {
+  float: left;
+  color: white;
+  text-align: center;
+  padding: 14px 16px;
+  text-decoration: none;
+  font-size: 17px;
+  font-family: Arial, Helvetica, sans-serif;
+  position: sticky;
+}
+
+.topnav a:hover {
+  background-color: lightblue;
+  color: black;
+}
+
+.topnav a.active {
+  background-color: lightseagreen;
+  color: black;
+}
+
+.regular-text {
+    font-size: 20px;
+    padding: 20px;
+}
+
+li{
+    padding-top: 0px;
+    padding-bottom: 10px;
+    font-size: 20px;
+}
diff --git a/docs/index.html b/docs/index.html
@@ -1,32 +1,94 @@
----
-layout: default
----
+<!DOCTYPE html>
 
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-EPIC (Elliptical Parcel-In-Cell) is a software package to simulate general two and three-dimensional flows.
 
-<!-- <a href="html/intro.html">Manual</a> -->
+<title>Elliptical Parcel-In-Cell</title>
 
-<figure>
-    <img src="straka.jpg" alt="Straka">
-    <figcaption>Figure 1: Simulation of the Straka density current test case using 512x64 grid cells.</figcaption>
-</figure>
+<link rel="stylesheet" type="text/css" href="index.css">
 
+</head>
 
-<video width="960" height="540" controls autoplay muted>
-    <source src="hybrid_straka.mp4" type="video/mp4">
-    Your browser does not support the video tag.
-</video>
+<body>
 
+<div class="topnav">
+  <a class="active" href="#home">Home</a>
+  <a href="gallery">Gallery</a>
+  <a href="help">Need Help</a>
+</div>
 
-<video width="540" height="960" controls autoplay muted>
-    <source src="hybrid_robert.mp4" type="video/mp4">
-    Your browser does not support the video tag.
-</video>
 
-<h2>Contributors</h2>
+<!-- <img src="straka.jpg" alt="Straka" width="device-width"> -->
+
+<h1>The Elliptical Parcel-In-Cell (EPIC) method</h1>
+
+<img style="padding-left: 20px" src="straka.jpg" alt="Straka" width="1000px">
+
+<p class="regular-text">
+The EPIC code is an open-source framework written in Fortran 2018 to simulate
+general two and three-dimensional flows. The primary focus of the current implementation
+is on buoyancy-driven turbulent flows for cloud convection. It uses elliptical Lagrangian parcels
+that deform based on the local strain field. The gridded velocity is obtained by efficient inversion
+of the interpolated parcel vorticity on the Eulerian grid.
+</p>
+
+
+<p class="regular-text">
+Detailed information about the numerics is found in
 <ul>
-    <li>Matthias Frey</li>
-    <li>David Dritschel</li>
-    <li>Steven J. Böing</li>
+    <li>
+        M. Frey, D. Dritschel, S. Böing,
+        <a href="https://doi.org/10.1016/j.jcpx.2022.100109" target="_blank">
+        EPIC: The Elliptical Parcel-In-Cell method
+        </a>,
+        J. of Comp. Phys.: X 14 (2022) 100109.
+    </li>
+    <li>
+        M. Frey, D. Dritschel, S. Böing,
+        <a href="https://doi.org/10.1016/j.jcpx.2023.100136" target="_blank">
+        The 3D Elliptical Parcel-In-Cell (EPIC) method
+        </a>,
+        J. of Comp. Phys.: X, 17 (2023), 100136.
+    </li>
 </ul>
+</p>
+
+<p class="regular-text">
+The current teams consists of
+<ul>
+    <li>
+        <a href="https://research-portal.st-andrews.ac.uk/en/persons/matthias-frey"
+           target="_blank">
+           Matthias Frey</a>,
+           University of St Andrews
+    </li>
+    <li>
+        <a href="https://research-portal.st-andrews.ac.uk/en/persons/david-gerard-dritschel"
+           target="_blank">
+           David Dritschel</a>,
+           University of St Andrews
+    </li>
+    <li>
+        <a href="https://environment.leeds.ac.uk/see/staff/1165/dr-steven-boeing"
+           target="_blank">
+           Steven J. Böing</a>,
+           University of Leeds
+    </li>
+    <li>
+        <a href="https://www.epcc.ed.ac.uk/about-us/our-team/dr-rui-apostolo"
+           target="_blank">
+           Rui Apostolo</a>,
+           Edinburgh Parallel Computing Centre (EPCC)
+    </li>
+</ul>
+</p>
+
+<!-- If you use EPIC for your research, please cite the latest source code DOI which is found -->
+<!-- on <a href="https://zenodo.org/records/10710859" target="_blank">Zenodo</a> -->
+
+
+</body>
diff --git a/docs/hybrid_robert.mp4 → docs/videos/hybrid_robert.mp4 b/docs/hybrid_robert.mp4 → docs/videos/hybrid_robert.mp4
diff --git a/docs/hybrid_straka.mp4 → docs/videos/hybrid_straka.mp4 b/docs/hybrid_straka.mp4 → docs/videos/hybrid_straka.mp4