Skip to content

Commit

Permalink
Doc v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
treyssede committed Feb 6, 2024
1 parent e143afe commit 2f96ad5
Show file tree
Hide file tree
Showing 32 changed files with 397 additions and 577 deletions.
6 changes: 2 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[![Generic badge](https://github.com/Universite-Gustave-Eiffel/waveguicsx/actions/workflows/pages/pages-build-deployment/badge.svg)](https://universite-gustave-eiffel.github.io/waveguicsx/)

# waveguicsx

waveguicsx, a python library for solving complex waveguide problems
Copyright (C) 2023-2024 Fabien Treyssede
**waveguicsx, a python library for solving complex waveguide problems**
**Copyright (C) 2023-2024 Fabien Treyssede**

This file is part of waveguicsx.

Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 911996878fa4ed10ee56b000e7e81898
config: aa88b81474f255454ee0a8244097e2c9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/.doctrees/documentation.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
View file
Binary file not shown.
Binary file removed docs/.doctrees/modules.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/readme_link.doctree
View file
Binary file not shown.
Binary file renamed docs/.doctrees/examples.doctree → docs/.doctrees/tutorials.doctree
View file
Binary file not shown.
Binary file removed docs/.doctrees/waveguicsx.doctree
View file
Binary file not shown.
Empty file removed docs/.nojekyll
View file
Empty file.
44 changes: 23 additions & 21 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; waveguicsx 1.0 documentation</title>
<title>Overview: module code &mdash; waveguicsx 1.1 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]>
Expand Down Expand Up @@ -40,30 +40,32 @@
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../readme_link.html">waveguicsx</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../readme_link.html">Presentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#introduction">0. Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#prerequisites">1. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#installation">2. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#documentation">3. Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#tutorials">4. Tutorials</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#authors-and-contributors">5. Authors and contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#how-to-cite">6. How to cite</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#license">7. License</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#basic-examples">1. Basic examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#prerequisites">2. Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#installation">3. Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#documentation">4. Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#tutorials">5. Tutorials</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#authors-and-contributors">6. Authors and contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#how-to-cite">7. How to cite</a></li>
<li class="toctree-l2"><a class="reference internal" href="../readme_link.html#license">8. License</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../modules.html">Modules</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../waveguicsx.html">waveguicsx.waveguide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../documentation.html#waveguicsx.waveguide.Waveguide"><code class="docutils literal notranslate"><span class="pre">Waveguide</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../documentation.html#waveguicsx.waveguide.Signal"><code class="docutils literal notranslate"><span class="pre">Signal</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#d-elastic-bar-of-square-cross-section">3D elastic bar of square cross-section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#d-elastic-bar-of-square-cross-section-with-parallelization">3D elastic bar of square cross-section with parallelization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#d-elastic-bar-of-square-cross-section-buried-into-a-pml-external-medium">3D elastic bar of square cross-section buried into a PML external medium</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#d-elastic-bar-of-square-cross-section-buried-into-a-pml-external-medium-using-gmsh">3D elastic bar of square cross-section buried into a PML external medium using gmsh</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#excitation-of-a-3d-elastic-bar-of-circular-cross-section">Excitation of a 3D elastic bar of circular cross-section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#excitation-of-a-3d-elastic-bar-of-circular-cross-section-with-parallelization">Excitation of a 3D elastic bar of circular cross-section with parallelization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#time-response-of-a-plate-excited-near-its-first-zgv-resonance">Time response of a plate excited near its first ZGV resonance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../examples.html#dispersion-curves-of-a-rail">Dispersion curves of a rail</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#d-elastic-bar-of-square-cross-section">3D elastic bar of square cross-section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#d-elastic-bar-of-square-cross-section-with-parallelization">3D elastic bar of square cross-section with parallelization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#d-elastic-bar-of-square-cross-section-buried-into-a-pml-external-medium">3D elastic bar of square cross-section buried into a PML external medium</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#d-elastic-bar-of-square-cross-section-buried-into-a-pml-external-medium-using-gmsh">3D elastic bar of square cross-section buried into a PML external medium using gmsh</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#excitation-of-a-3d-elastic-bar-of-circular-cross-section">Excitation of a 3D elastic bar of circular cross-section</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#excitation-of-a-3d-elastic-bar-of-circular-cross-section-with-parallelization">Excitation of a 3D elastic bar of circular cross-section with parallelization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#time-response-of-a-plate-excited-near-its-first-zgv-resonance">Time response of a plate excited near its first ZGV resonance</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorials.html#dispersion-curves-of-a-rail">Dispersion curves of a rail</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -102,7 +104,7 @@ <h1>All modules for which code is available</h1>
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023, Fabien Treyssede.</p>
<p>&#169; Copyright 2023-2024, Fabien Treyssede.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
Expand Down
Loading

0 comments on commit 2f96ad5

Please sign in to comment.