From a6e13f5eb4ed43512b927f563a4738bbddbb5bd2 Mon Sep 17 00:00:00 2001 From: Yingqian Liao <36197991+yqliaohk@users.noreply.github.com> Date: Mon, 14 Dec 2020 11:07:22 -0500 Subject: [PATCH] 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 <36549388+marcomangano@users.noreply.github.com> Co-authored-by: Neil Wu Co-authored-by: Neil Wu --- README.md | 1 + conf.py | 5 +++++ machAeroTutorials/opt_aero.rst | 8 ++++++++ requirements.txt | 2 +- 4 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 100d135..7f659c5 100644 --- a/README.md +++ b/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``. diff --git a/conf.py b/conf.py index cca4e31..b1e099f 100644 --- a/conf.py +++ b/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), +} diff --git a/machAeroTutorials/opt_aero.rst b/machAeroTutorials/opt_aero.rst index e949dad..19da634 100644 --- a/machAeroTutorials/opt_aero.rst +++ b/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 `. + 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:: diff --git a/requirements.txt b/requirements.txt index 9457f83..bc2e1f6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ -sphinxcontrib.bibtex +sphinxcontrib-bibtex==1.0.0 sphinx_mdolab_theme