sphinx-docs

lanl · Oct 30, 2023 · 9038ed9 · 9038ed9
1 parent 3b9c74a
commit 9038ed9
Show file tree

Hide file tree

Showing 156 changed files with 39,604 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,27 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - name: Install dependencies
+        run: |
+          pip install sphinx sphinx_rtd_theme myst_parser
+      - name: Sphinx build
+        run: |
+          sphinx-build doc _build
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _build/
+          force_orphan: true
diff --git a/docs/_images/4_user_ellipses.png b/docs/_images/4_user_ellipses.png
diff --git a/docs/_images/4_user_rectangles.png b/docs/_images/4_user_rectangles.png
diff --git a/docs/_images/TPL_pathlines.png b/docs/_images/TPL_pathlines.png
diff --git a/docs/_images/dead-end_velocity_field.png b/docs/_images/dead-end_velocity_field.png
diff --git a/docs/_images/dfn_2_core.png b/docs/_images/dfn_2_core.png
diff --git a/docs/_images/dfn_graph.png b/docs/_images/dfn_graph.png
diff --git a/docs/_images/exp_pressure.png b/docs/_images/exp_pressure.png
diff --git a/docs/_images/forsmark_trajectories.png b/docs/_images/forsmark_trajectories.png
diff --git a/docs/_images/in-fracture-variability_pathlines.png b/docs/_images/in-fracture-variability_pathlines.png
diff --git a/docs/_images/math/02c849aad7960bc828467cc5933f8fe020201c4b.png b/docs/_images/math/02c849aad7960bc828467cc5933f8fe020201c4b.png
diff --git a/docs/_images/math/261e3eb56c1757dd003745ee4cc53aa595565af1.png b/docs/_images/math/261e3eb56c1757dd003745ee4cc53aa595565af1.png
diff --git a/docs/_images/math/279e5f07d040abb28b85734dce062ae251eb1c7b.png b/docs/_images/math/279e5f07d040abb28b85734dce062ae251eb1c7b.png
diff --git a/docs/_images/math/2e0bcb32a282b693f93afdd203ce17b9b558ff79.png b/docs/_images/math/2e0bcb32a282b693f93afdd203ce17b9b558ff79.png
diff --git a/docs/_images/math/2f5aa019312e1bbc969deab8dca8b00f76025404.png b/docs/_images/math/2f5aa019312e1bbc969deab8dca8b00f76025404.png
diff --git a/docs/_images/math/345f606ec4423cb6fa147f63a5da5a98ee48c1bb.png b/docs/_images/math/345f606ec4423cb6fa147f63a5da5a98ee48c1bb.png
diff --git a/docs/_images/math/36bc2e342149719661caf719641e17da4ee2dfe6.png b/docs/_images/math/36bc2e342149719661caf719641e17da4ee2dfe6.png
diff --git a/docs/_images/math/416cf0520ab360f9e5d8f8e778bb5657fe846cbb.png b/docs/_images/math/416cf0520ab360f9e5d8f8e778bb5657fe846cbb.png
diff --git a/docs/_images/math/49c53391daff97aa7d155674c12e14f9e6ba1c93.png b/docs/_images/math/49c53391daff97aa7d155674c12e14f9e6ba1c93.png
diff --git a/docs/_images/math/4a3598141469c2555591e66606a1b86d4ec6dca9.png b/docs/_images/math/4a3598141469c2555591e66606a1b86d4ec6dca9.png
diff --git a/docs/_images/math/4ed396e004eb768a13e92e60d6ec6ca2d8406bc3.png b/docs/_images/math/4ed396e004eb768a13e92e60d6ec6ca2d8406bc3.png
diff --git a/docs/_images/math/5406eadc281dbd20de843b0034c8497320dae5cb.png b/docs/_images/math/5406eadc281dbd20de843b0034c8497320dae5cb.png
diff --git a/docs/_images/math/5b514159f8b6bf75e6317d628c7caf2df737075c.png b/docs/_images/math/5b514159f8b6bf75e6317d628c7caf2df737075c.png
diff --git a/docs/_images/math/5f01a802667a3ba5b8994a25f3fdf78bf8593563.png b/docs/_images/math/5f01a802667a3ba5b8994a25f3fdf78bf8593563.png
diff --git a/docs/_images/math/5fd160b4cce0043bb255b69534567d66c7701e55.png b/docs/_images/math/5fd160b4cce0043bb255b69534567d66c7701e55.png
diff --git a/docs/_images/math/64cfd851ec561560ab02a61550edfe6939966211.png b/docs/_images/math/64cfd851ec561560ab02a61550edfe6939966211.png
diff --git a/docs/_images/math/68c7c8c65602677ab56cf7fd88002023f0edc575.png b/docs/_images/math/68c7c8c65602677ab56cf7fd88002023f0edc575.png
diff --git a/docs/_images/math/6cf2be4eba28e4c7a7daec65d0075aae07bb173e.png b/docs/_images/math/6cf2be4eba28e4c7a7daec65d0075aae07bb173e.png
diff --git a/docs/_images/math/73f4958e89c005c29b46fe025be4584c439caa4b.png b/docs/_images/math/73f4958e89c005c29b46fe025be4584c439caa4b.png
diff --git a/docs/_images/math/761a700ecec9ede79c472b840375d1398c81a1aa.png b/docs/_images/math/761a700ecec9ede79c472b840375d1398c81a1aa.png
diff --git a/docs/_images/math/7dfd566f04990e72a20ff38301773d0a0cf37845.png b/docs/_images/math/7dfd566f04990e72a20ff38301773d0a0cf37845.png
diff --git a/docs/_images/math/8a87f04e7d7cca18343c084cceca5237fae62491.png b/docs/_images/math/8a87f04e7d7cca18343c084cceca5237fae62491.png
diff --git a/docs/_images/math/8cf77d2801619424ae7a84211bb1a8cca8795192.png b/docs/_images/math/8cf77d2801619424ae7a84211bb1a8cca8795192.png
diff --git a/docs/_images/math/9630132210b904754c9ab272b61cb527d12263ca.png b/docs/_images/math/9630132210b904754c9ab272b61cb527d12263ca.png
diff --git a/docs/_images/math/a093d21e837b340ae5112488ff176fc6c8492c87.png b/docs/_images/math/a093d21e837b340ae5112488ff176fc6c8492c87.png
diff --git a/docs/_images/math/a20864ec4268c5cf0fdd0c4e76a69bbb74733b54.png b/docs/_images/math/a20864ec4268c5cf0fdd0c4e76a69bbb74733b54.png
diff --git a/docs/_images/math/a963655a01fb22852c131f0d8e66066026c39fb8.png b/docs/_images/math/a963655a01fb22852c131f0d8e66066026c39fb8.png
diff --git a/docs/_images/math/a9a7d5b5b78fb63c537c462714d97ffd7c091829.png b/docs/_images/math/a9a7d5b5b78fb63c537c462714d97ffd7c091829.png
diff --git a/docs/_images/math/af5573a7b3374f4e3287488adf152892c0f16488.png b/docs/_images/math/af5573a7b3374f4e3287488adf152892c0f16488.png
diff --git a/docs/_images/math/b4ecdaef430093e2c63ec36545fdc953d7b1449c.png b/docs/_images/math/b4ecdaef430093e2c63ec36545fdc953d7b1449c.png
diff --git a/docs/_images/math/b52df27bfb0b1e3af0c2c68a7b9da459178c2a7d.png b/docs/_images/math/b52df27bfb0b1e3af0c2c68a7b9da459178c2a7d.png
diff --git a/docs/_images/math/bf4d6dded1f2769dd9942a7e0071045945dbeb9a.png b/docs/_images/math/bf4d6dded1f2769dd9942a7e0071045945dbeb9a.png
diff --git a/docs/_images/math/cefc603e5658facb747581f9567192993f21c7ab.png b/docs/_images/math/cefc603e5658facb747581f9567192993f21c7ab.png
diff --git a/docs/_images/math/d549c46bd87138576a59f5cb8578b1e7c7ba4344.png b/docs/_images/math/d549c46bd87138576a59f5cb8578b1e7c7ba4344.png
diff --git a/docs/_images/math/e24906bf3a64d622f266503cd7146a8de74a258d.png b/docs/_images/math/e24906bf3a64d622f266503cd7146a8de74a258d.png
diff --git a/docs/_images/math/e8dea8254118f111b5fb20895b03528c17566f06.png b/docs/_images/math/e8dea8254118f111b5fb20895b03528c17566f06.png
diff --git a/docs/_images/math/ef0f29bda011efb4abda29f5620732e335ad5e42.png b/docs/_images/math/ef0f29bda011efb4abda29f5620732e335ad5e42.png
diff --git a/docs/_images/math/f709b2722911463d06271f2320d386c4f3ab88fe.png b/docs/_images/math/f709b2722911463d06271f2320d386c4f3ab88fe.png
diff --git a/docs/_images/math/ff4552ec4e1115499121b2cc24265a14c7aa7b1c.png b/docs/_images/math/ff4552ec4e1115499121b2cc24265a14c7aa7b1c.png
diff --git a/docs/_images/math/fffd2357ee88a9c50ba9e831ed64c39c73d54a07.png b/docs/_images/math/fffd2357ee88a9c50ba9e831ed64c39c73d54a07.png
diff --git a/docs/_images/power_mesh.png b/docs/_images/power_mesh.png
diff --git a/docs/_images/pruned_network.png b/docs/_images/pruned_network.png
diff --git a/docs/_images/time_co2.png b/docs/_images/time_co2.png
diff --git a/docs/_images/well-pressure.png b/docs/_images/well-pressure.png
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -0,0 +1,140 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; dfnWorks 2.7 documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=ab527d87"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index_docs.html" class="icon icon-home">
+            dfnWorks
+              <img src="../_static/dfnworks_logo.png" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                2.7, LANL, Docs: LA-UR-17-22216, Software: LA-CC-17-027
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../intro.html">Welcome To dfnWorks</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../applications.html">Example Applications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../setup.html">Setting and Running up dfnWorks</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pydfnworks.html">pydfnworks: the dfnWorks python package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pydfnGen.html">pydfnworks: dfnGen</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pydfnFlow.html">pydfnworks: dfnFlow</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pydfnTrans.html">pydfnworks: dfnTrans</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pydfnGraph.html">pydfnworks: dfnGraph</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../pydfnWorks-well.html">pydfnworks: Well Package</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../dfngen.html">dfnGen - C++ Generation Code</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../dfnflow.html">dfnFlow</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../dfntrans.html">dfnTrans</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../output.html">Run Files</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../publications.html">dfnWorks Publications</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../gallery.html">dfnWorks Gallery</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index_docs.html">dfnWorks</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index_docs.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="pydfnworks/dfnFlow/fehm.html">pydfnworks.dfnFlow.fehm</a></li>
+<li><a href="pydfnworks/dfnFlow/flow.html">pydfnworks.dfnFlow.flow</a></li>
+<li><a href="pydfnworks/dfnFlow/mass_balance.html">pydfnworks.dfnFlow.mass_balance</a></li>
+<li><a href="pydfnworks/dfnFlow/pflotran.html">pydfnworks.dfnFlow.pflotran</a></li>
+<li><a href="pydfnworks/dfnGen/generation/generator.html">pydfnworks.dfnGen.generation.generator</a></li>
+<li><a href="pydfnworks/dfnGen/generation/input_checking/check_input.html">pydfnworks.dfnGen.generation.input_checking.check_input</a></li>
+<li><a href="pydfnworks/dfnGen/generation/input_checking/fracture_family.html">pydfnworks.dfnGen.generation.input_checking.fracture_family</a></li>
+<li><a href="pydfnworks/dfnGen/generation/input_checking/user_defined_fracture_functions.html">pydfnworks.dfnGen.generation.input_checking.user_defined_fracture_functions</a></li>
+<li><a href="pydfnworks/dfnGen/generation/output_report/gen_output.html">pydfnworks.dfnGen.generation.output_report.gen_output</a></li>
+<li><a href="pydfnworks/dfnGen/generation/stress.html">pydfnworks.dfnGen.generation.stress</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/add_attribute_to_mesh.html">pydfnworks.dfnGen.meshing.add_attribute_to_mesh</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/mesh_dfn.html">pydfnworks.dfnGen.meshing.mesh_dfn</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/mesh_dfn_helper.html">pydfnworks.dfnGen.meshing.mesh_dfn_helper</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/udfm/false_connections.html">pydfnworks.dfnGen.meshing.udfm.false_connections</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/udfm/map2continuum.html">pydfnworks.dfnGen.meshing.udfm.map2continuum</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/udfm/upscale.html">pydfnworks.dfnGen.meshing.udfm.upscale</a></li>
+<li><a href="pydfnworks/dfnGen/well_package/wells.html">pydfnworks.dfnGen.well_package.wells</a></li>
+<li><a href="pydfnworks/dfnGraph/dfn2graph.html">pydfnworks.dfnGraph.dfn2graph</a></li>
+<li><a href="pydfnworks/dfnGraph/graph_flow.html">pydfnworks.dfnGraph.graph_flow</a></li>
+<li><a href="pydfnworks/dfnGraph/graph_transport.html">pydfnworks.dfnGraph.graph_transport</a></li>
+<li><a href="pydfnworks/dfnGraph/pruning.html">pydfnworks.dfnGraph.pruning</a></li>
+<li><a href="pydfnworks/dfnTrans/transport.html">pydfnworks.dfnTrans.transport</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2020, LANL, LA-UR-17-22216.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>