Update docs and prep for 2.15 release (#475)

* update docs following the switch to meson-python

* only discuss editable install in contributor page

* update clean install docs

* bump version

* backport issue found from conda-forge on fortran arg for SNOPT

* temporary pin on docutils due to sphinx-tabs

* format

* options file no longer needed

* add note on cleaning build dir

Author: ewu63

doc/contribute.rst

@@ -22,6 +22,13 @@ Then, do the following:
 
     pip install --no-build-isolation --editable .
 
+Unlike typical installs, this will leave the build directory in place, so in subsequent builds it is best to clean the build directory first via
+
+.. prompt:: bash
+
+    rm -rf build
+
+
 To run tests, ensure that the testing dependencies specified in the ``pyproject.toml`` file are also installed.
 
 Coding style

doc/install.rst

@@ -11,7 +11,7 @@ Conda packages are available on conda-forge and can be installed via
 
   conda install -c conda-forge pyoptsparse
 
-This would install pyOptSparse with the built-in optimizers.
+This would install pyOptSparse with the built-in optimizers, plus IPOPT.
 If you wish to use optimizers not packaged by ``conda``, e.g. SNOPT, then you must either build the package from source or use the installation script below.
 If you have the SNOPT precompiled library available, it is possible to dynamically link it to pyOptSparse following the instructions on the :ref:`SNOPT installation page<snopt_by_conda>`.
 
@@ -29,7 +29,7 @@ Requirements
 ~~~~~~~~~~~~
 pyOptSparse has the following dependencies:
 
-* Python 3.7 or 3.8, though other Python 3 versions will likely work
+* Python 3
 * C and Fortran compilers.
   We recommend ``gcc`` and ``gfortran`` which can be installed via the package manager for your operating system.
 
@@ -38,12 +38,8 @@ Python dependencies are automatically handled by ``pip``, so they do not need to
 
 .. note::
   * In Linux, the python header files (``python-dev``) are also required.
-  * **We do not support operating systems other than Linux.**
-    For macOS users, the conda package may work out of the box if you do not need any non-default optimizers.
-    Also, the installation script by OpenMDAO likely works on macOS.
-    For Windows users, a conda package is on the way, if it's not already in the repos.
-    This comes with the same disclaimer as the macOS conda package.
-    Alternatively, follow the :ref:`conda build instructions<conda build instruction>` below as this will work on any platform.
+  * **We do not support operating systems other than Linux** for building from source.
+    For those on other operating systems, you can try the :ref:`conda build instructions<conda build instruction>` instead.
 
 Installation
 ~~~~~~~~~~~~
@@ -61,8 +57,6 @@ For those not using virtual environments, a user install may be needed
 
   pip install . --user
 
-If you plan to modify pyOptSparse, installing with the developer option, i.e. with ``-e``, will save you from re-installing each time you modify the Python code.
-
 .. note::
   Some optimizers are proprietary, and their sources are not distributed with pyOptSparse.
   To use them, please follow the instructions on specific optimizer pages.
@@ -122,11 +116,7 @@ The first thing to do is to do a clean install.
 This involves the following steps:
 
 #. Uninstall the package via ``pip``
-#. If you did a developer install (with ``-e``), check if there are ``.so`` files in the subdirectories, e.g. ``pyoptsparse/pySLSQP``.
-   If so, manually delete all ``.so`` files.
-#. Remove the ``meson_build`` directory if present.
-#. Run ``pip install`` again and test the installation.
-
+#. Run ``pip install .`` again and test the installation.
 
 If the issue persists, there is probably a linking or runtime issue.
 This can be verified by manually importing the compiled library that's causing the issue, for example with:
@@ -142,7 +132,7 @@ If, on the other hand, this throws a ``error while loading shared libraries``, t
 
 Update or Uninstall
 -------------------
-To update pyOptSparse, first delete the ``meson_build`` directory, then update the package using ``git``.
+To update pyOptSparse, first update the package using ``git``.
 For stability, users are encouraged to stick to tagged releases.
 Install the package normally via ``pip``.
 

doc/requirements.txt

@@ -1,2 +1,4 @@
 sphinx_mdolab_theme>=1.2
 sphinx-codeautolink
+# temporary pin from https://github.com/executablebooks/sphinx-tabs/issues/212
+docutils==0.21.2

meson_options.txt

@@ -1,4 +1,4 @@
-__version__ = "2.14.5"
+__version__ = "2.15.0"
 
 from .pyOpt_history import History
 from .pyOpt_variable import Variable
@@ -41,4 +41,6 @@
     "NSGA2",
     "ALPSO",
     "ParOpt",
+    "testing",
+    "list_optimizers",
 ]

pyoptsparse/__init__.py

@@ -24,6 +24,5 @@ if HAS_SNOPT
     dependencies : [fortranobject_dep],
     subdir: 'pyoptsparse/pySNOPT',
     install: true,
-    fortran_args: '-ffixed-line-length-80'
   )
 endif