EDGE's User Guide @GitBook

Updated 8 months ago


Hey there, you have reached the user guide of the Extreme-scale Discontinuous Galerkin Environment (EDGE). EDGE uses the Discontinuous Galerkin (DG-) Finite Element Method (FEM) to solve hyperbolic partial differential equations. EDGE supports different equations and element types.

Currently, the applications focus is on seismic simulations through the elastic wave equations and on unstructured tetrahedral meshes. Here, EDGE targets seismic model setups with high geometric complexity and extreme-scale ensemble simulations. The entire software stack is uniquely tailored to "fused" simulations. Fused simulations allow for different model setups within one execution of the forward solver. For example, you could share the mesh and velocity model in the fused runs, but alter the kinematic source from run to run. This approach allows the code to exploit inter-simulation parallelism and reach significantly higher simulation throughput. Typically, the speedup is around 2-5 times, depending on the configuration. In short: Fusing simulations makes the code faster.

EDGE is distributed across different resources. First of all, there is this user guide, which you are currently reading. The main purpose of the user guide is to guide you through the installation of the code and the setup of simulations. Be warned, we just started writing and important chapters might be missing. If you run into trouble, use one of the issue trackers and we'll have a look at it together. This user guide's issue tracker is available at https://github.com/3343/edge_usr/issues, the issue tracker of the code at https://github.com/3343/edge/issues.

The next resource is the software itself. EDGE only provides source code, which is nice because you can always look at the guts of the software, but requires you to go through the compilation yourself. Then there are the assets, which are example setups, and supporting scripts and data. For example, this is the place where setups for benchmarks and unit tests are hosted. EDGE's developer guide describes what's going on under the hood of the code. Finally, EDGE's homepage http://dial3343.org provides up-to-date information on the Extreme-scale Discontinuous Galerkin Environment. To reach any of EDGE's other resources, consider using the dispatcher.

BSD 3-Clause and CC0

Disclaimer: We do not provide legal advice. The provided information is incomplete and is not a substitute for legal advice.

EDGE's core is licensed under the BSD 3-Clause license. This does not apply to dependencies and used libraries. Libraries are either directly located in the directory submodules or included through .gitmodules. For the master branch the directory is located here and .gitmodules located here. EDGE's automated FOSSA-reports might be helpful for further details on the licenses:

The sources of this user guide, and the sources of EDGE's developer guide are CC0'd. An FAQ on CC0 is provided by Creative Commons.

EDGE's assets follow a mixed approach. Software-components, e.g., configurations for EDGE's core, or scripts, are BSD Clause-3. Other, non-software files, e.g., generated meshes, or source-input are CC0'd to a large extend. However, if, for example, used topography of a mesh is provided under the CC BY license, a mesh might not be CC0'd.