.. _paropt:

ParOpt
======
ParOpt is a nonlinear interior point optimizer that is designed for large parallel design optimization problems with structured sparse constraints.
ParOpt is open source and can be downloaded at `https://github.com/smdogroup/paropt <https://github.com/smdogroup/paropt>`_.
Documentation and examples for ParOpt can be found at `https://smdogroup.github.io/paropt/ <https://smdogroup.github.io/paropt/>`_.
The version of ParOpt supported is v2.0.2.

Installation
------------
Please follow the instructions `here <https://smdogroup.github.io/paropt/>`_ to install ParOpt as a separate Python package.
Make sure that the package is named ``paropt`` and the installation location can be found by Python, so that ``from paropt import ParOpt`` works within the pyOptSparse folder.
This typically requires installing it in a location which is already present under ``$PYTHONPATH`` environment variable, or you can modify the ``.bashrc`` file and manually append the path.

Options
-------
Please see the ParOpt documentation for all available options.

API
---
.. currentmodule:: pyoptsparse.pyParOpt.ParOpt

.. autoclass:: ParOpt
   :members: __call__