Added matrix equation to documentation (#55)

* added block matrix equation to readme and docs * typo
mdolab · Nov 17, 2023 · a4f79f1 · a4f79f1
1 parent 5f154fe
commit a4f79f1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -14,9 +14,11 @@ Please see the [documentation](https://mdolab-pyxdsm.readthedocs-hosted.com) for
 To locally build the documentation, enter the `doc` folder and enter `make html` in the terminal. 
 You can then view the built documentation in the `_build` folder.
 
+### XDSM diagram
 ![XDSM of MDF](doc/images/mdf.png)
 
-
+### Block matrix equation
+![Block matrix equation](doc/images/matrix_eqn.png)
 
 ## Citation
 Please cite the [paper by Lambe and Martins](http://mdolab.engin.umich.edu/bibliography/Lambe2012a.html) when using XDSM.

diff --git a/doc/examples.rst b/doc/examples.rst
@@ -24,4 +24,14 @@ Here is an example that uses a whole bunch of the more advanced features in ``py
    :scale: 30
 
 It is mostly just a reference for all the customizations you can do.
-The code for this diagram is `provided here <https://github.com/mdolab/pyXDSM/blob/master/examples/kitchen_sink.py>`_
+The code for this diagram is `provided here <https://github.com/mdolab/pyXDSM/blob/master/examples/kitchen_sink.py>`_
+
+
+Block matrix equation
+---------------------
+
+``pyXDSM`` can also generate a figure of a block matrix equation.
+An example script is available `here <https://github.com/mdolab/pyXDSM/blob/master/examples/mat_eqn.py>`_.
+
+.. image:: images/matrix_eqn.png
+   :scale: 15
diff --git a/doc/images/matrix_eqn.png b/doc/images/matrix_eqn.png