Browse Source

Update readme

Snow 8 years ago
parent
commit
993c737ee4
1 changed files with 24 additions and 1 deletions
  1. 24 1
      README.md

+ 24 - 1
README.md

@@ -1 +1,24 @@
-# Test
+<div id="table-of-contents">
+<h2>Table of Contents</h2>
+<div id="text-table-of-contents">
+<ul>
+<li><a href="#sec-1">1. HDPG1D</a></li>
+<li><a href="#sec-2">2. Install</a></li>
+<li><a href="#sec-3">3. Usage</a></li>
+</ul>
+</div>
+</div>
+
+# HDPG1D<a id="sec-1" name="sec-1"></a>
+
+This is a python package that solves 1-Dimensional PDEs using hybridizable discontinuous Petrov-Galerkin discretization, a novel FEA discretization that ensures the best solution quality without extra stablization mechanism.
+
+[Solution of Burger's equation using HDPG.](file:///home/nico/ownCloud/2016%20Fall%20Lab%20Work/HDPG/HDPG1d/HDPGburgers30.pdf)
+
+# Install<a id="sec-2" name="sec-2"></a>
+
+`pip install hdpg1d`
+
+# Usage<a id="sec-3" name="sec-3"></a>
+
+    PGsolve