Added a note on optoptions and updated readme and requirement (#25)

* Added a note on optoptions and updated readme and requirement

* Minor edits

* Update conf.py

* switched to intersphinx

Co-authored-by: Marco Mangano <[email protected]>
Co-authored-by: Neil Wu <[email protected]>
Co-authored-by: Neil Wu <[email protected]>

Author: 3 people

README.md

@@ -30,3 +30,4 @@ This repository contains the following:
 
 These documentation can be accessed online at https://mdolab-mach-aero.readthedocs-hosted.com/.
 To run the tutorials yourself, you need to follow the installation instructions to install all the modules, then clone this repository to access the tutorial scripts.
+To compile the doc locally, first install dependencies via ``pip install -r requirements.txt``, then build locally with ``make html``.

conf.py

@@ -8,3 +8,8 @@
 # here we add external extensions, which must also be added to requirements.txt
 # so that RTD can import and use them
 extensions.extend(["sphinxcontrib.bibtex"])
+
+# Specify the baseurls for the projects I want to link to
+intersphinx_mapping = {
+    "pyoptsparse": ("https://mdolab-pyoptsparse.readthedocs-hosted.com/en/latest", None),
+}

machAeroTutorials/opt_aero.rst

@@ -206,6 +206,14 @@ To finish up, we choose the optimizer and then run the optimization.
 .. literalinclude:: ../tutorial/opt/aero/aero_opt.py
     :start-after: # rst optimizer
 
+.. note::
+    The complete set of options for ``SNOPT`` can be found in :ref:`the pyOptSparse documentation <pyoptsparse:snopt>`.
+    It is useful to remember that you can include major iterations information in the history file by providing the proper options.
+    It has been observed that the ``_print`` and ``_summary`` files occasionally fail to be updated, possibly due to unknown hardware issues on GreatLakes.
+    The problem is not common, but if you want to avoid losing this information, you might back it up in the history file.
+    This would allow you monitor the optimization even if the ``_print`` and ``_summary`` files are not being updated.
+    Note that the size of the history file will increase due to this additional data.
+
 Run it yourself!
 ================
 To run the script, use the ``mpirun`` and place the total number of processors after the ``-np`` argument::

requirements.txt

@@ -1,2 +1,2 @@
-sphinxcontrib.bibtex
+sphinxcontrib-bibtex==1.0.0
 sphinx_mdolab_theme