Merge pull request #213 from OpenTerrace/development

Development

Author: jakobhaervig

.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 MANIFEST
 src/
 *.lock
+site
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

README.md

@@ -25,5 +25,9 @@ OpenTerrace is built from the ground up to be flexible for easy integration in s
 - **EXTENDABLE**  
 Modules for new materials such as non-spherical rocks or exotic Phase Change Materials (PCM) can easily be plugged into the OpenTerrace framework.
 
-## Want to contribute?
-Contributions are most welcome! Feel free to send pull requests or [get in touch](https://openterrace.github.io/openterrace-python/contact/) to discuss how to collaborate.
+## Want to join the list of contributors?
+OpenTerrace welcomes contributions! Find more details  [here](./CONTRIBUTING.md). Current list of contributors:
+
+<a href="https://github.com/OpenTerrace/openterrace-python/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=OpenTerrace/openterrace-python&max=204" />
+</a>

docs/overrides/home.html

@@ -5,10 +5,17 @@
 {{ super() }}
 <style>
 
+
+
     .md-main {
         flex-grow: 0
     }
 
+    .md-container {
+        background: linear-gradient(to bottom, var(--md-primary-fg-color), hsla(160deg,47%,55%,1) 99%,#fff 99%)
+
+    }
+
     .md-main__inner {
         display: flex;
         height: 100%;
@@ -17,10 +24,10 @@
     .tx-container {
         padding-top: .0rem;
         background: linear-gradient(to bottom, var(--md-primary-fg-color), hsla(160deg,47%,55%,1) 99%,#fff 99%)
+        padding-bottom: .0rem;
     }
 
     .tx-hero {
-        margin: 32px 2.8rem;
         color: var(--md-primary-bg-color);
         justify-content: center;
     }

docs/user-guide/domains/lumped.md

@@ -64,9 +64,8 @@ plugins:
     handlers:
       python:
         paths: [openterrace]  # search packages in the src folder
-        setup_commands:
-          - import sys
-          - sys.path.append('openterrace')
+        options:
+          docstring_style: google
 
 nav:
   - index.md
@@ -97,7 +96,6 @@ nav:
           - user-guide/domains/block_1d.md
           - user-guide/domains/sphere_1d.md
           - user-guide/domains/hollow_sphere_1d.md
-          - user-guide/domains/lumped.md
       - Numerical schemes:
         - Diffusion:
           - user-guide/diffusion_schemes/central_difference_1d.md

mkdocs.yml

@@ -1,3 +1,4 @@
 __version__ = "0.0.0" # This will be overwritten by the dynamic versioning by Poetry
-from openterrace.openterrace import Simulate
+from openterrace.openterrace import Setup
+from openterrace.openterrace import Phase
 from openterrace.analytical_functions import *

openterrace/__init__.py

@@ -0,0 +1,4 @@
+import os, glob
+modules = glob.glob(os.path.join(os.path.dirname(__file__), "*.py"))
+__all__ = [ os.path.basename(f)[:-3] for f in modules if os.path.isfile(f) and not f.endswith('__init__.py')]
+from . import *

openterrace/boundary_conditions/__init__.py

@@ -0,0 +1,12 @@
+import numpy as np
+import numba as nb
+
+@nb.njit
+def lax_wendorf_1d(x, F):
+    """Second-order accurate, conditionally stable, conservative Lax-Wendroff advection scheme.
+    """
+    _out = np.zeros_like(x)
+    for j in range(1, x.shape[0]-1):
+        for i in range(0, x.shape[1]):
+            _out[j,i] = x[j,i] - 0.5 * F[0,j,i] * (x[j+1,i] - x[j-1,i]) + 0.5 * F[0,j,i]**2 * (x[j+1,i] - 2*x[j,i] + x[j-1,i])
+    return _out