thinking about user and developer guide

amanzi · Aug 28, 2024 · 5dcf3b7 · 5dcf3b7
1 parent 04307b3
commit 5dcf3b7
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/docs/documentation/source/concepts/domain.rst b/docs/documentation/source/concepts/domain.rst
@@ -0,0 +1,7 @@
+Model Domains
+=============
+
+Simulations, in Amanzi-ATS, consist of a coupled set of partial
+differential equations, typically solving for the conservation of some
+quantity (e.g. water mass, or energy, etc), solved on a **domain**.
+Here we define a domain to be a
diff --git a/docs/documentation/source/concepts/index.rst b/docs/documentation/source/concepts/index.rst
@@ -0,0 +1,26 @@
+Amanzi-ATS Concepts
+%%%%%%%%%%%%%%%%%%%
+
+Amanzi and ATS rely heavily on a set of concepts implemented in Arcos,
+an object-oriented library for multiphysics applications. These
+concepts are introduced here.
+
+.. toctree::
+   :maxdepth: 1
+
+   domain
+   region
+   variable_name
+   tag
+   record
+   record_set
+   evaluator
+   state
+   pk
+   mpc
+
+
+
+
+
+
diff --git a/docs/documentation/source/examples/index.rst b/docs/documentation/source/examples/index.rst
@@ -0,0 +1,16 @@
+Example Models
+%%%%%%%%%%%%%%
+
+Building upon these concepts, Amanzi and ATS are able to implement
+extremely complex application models at runtime.  It is useful to look
+at a few carefully selected examples of these to understand how the
+concepts are used to implement models.
+
+.. toctree::
+   :maxdepth: 1
+
+   richards
+   integrated_hydrology
+   flow_and_transport
+   subdomain_models
+
diff --git a/docs/documentation/source/index.rst b/docs/documentation/source/index.rst
@@ -61,6 +61,8 @@ User Guide
 .. toctree::
    :maxdepth: 1
 
+   developer/concepts/index
+   developer/examples/index
    demos
    input_spec/index