Skip to content

Commit

Permalink
ui doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
dangunter committed Sep 19, 2023
1 parent df9690e commit ff5ee5b
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 5 deletions.
12 changes: 8 additions & 4 deletions docs/explanations/components/ui/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
User Interfaces
===============

There are several types of user interfaces in IDAES:
There are several types of user interfaces in IDAES.
To learn more about them, follow the links below.

* Graphical user interfaces: see `Flowsheet Visualizer <https://idaes-ui.readthedocs.io/en/latest/fv.html>`_
* `Jupyter Notebooks <https://jupyter.org/>`_: see `IDAES Examples <https://idaes-examples.readthedocs.io/en/latest/>`_
* Python Application Programming Interfaces (APIs): see :ref:`API Reference`



* Graphical user interfaces: Flowsheet Visualizer
* Jupyter Notebooks: IDAES Examples
* Python Application Programming Interfaces: Reference
2 changes: 1 addition & 1 deletion docs/how_to_guides/opt_dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Available optional dependencies targets

As of IDAES 2.1, the following ``extras_require`` targets are available:

* ``ui``: for the `IDAES User Interface (UI) <https://github.com/IDAES/idaes-ui>`_
* ``ui``: for the `IDAES User Interface (UI) <https://github.com/IDAES/idaes-ui>`_ (`UI documentation <https://idaes-ui.readthedocs.io/en/latest/>`_)
* ``dmf``: for the :ref:`Data Management Framework <dmf-overview>`
* ``grid``: for the :ref:`IDAES Grid integration <idaes-grid>`
* ``omlt``: for the :ref:`OMLT integration <omlt>`
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ See also :doc:`IDAES concepts <explanations/concepts>` in this documentation.
| :doc:`Why IDAES <explanations/why_idaes>`
| :doc:`Concepts <explanations/concepts>`
| :doc:`Components of IDAES <explanations/components/index>`
| :doc:`User Interfaces <explanations/components/ui/index>`
| :doc:`Conventions <explanations/conventions>`
| :doc:`Model Diagnostics Workflow <explanations/model_diagnostics/index>`
| :doc:`Modeling Extensions <explanations/modeling_extensions/index>`
Expand Down
2 changes: 2 additions & 0 deletions docs/reference_guides/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _API Reference:

Reference Guides
=================

Expand Down

0 comments on commit ff5ee5b

Please sign in to comment.