.. nodeworks documentation master file, created by
   sphinx-quickstart on Mon Oct 19 13:11:32 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=====================================
Welcome to Nodeworks's documentation!
=====================================

`Nodeworks` is a library, developed by the `US Department of Energy's (DOE) National
Energy Technology Laboratory (NETL)`_ , for graphical programing through the use of
nodes and connections. Basic nodes are provided however the intent of this library is
for developers of GUIs (Graphical User Interface) to create custom nodes. This
library has been inspired by `pyqtgraph`_ and `Blender`_.

.. figure:: ../../screenshot.png
   :width: 800 px
   :align: center
   :figclass: align-center

.. toctree::
   :maxdepth: 2
   :caption: Getting Started
   :hidden:

   getting_started/about
   getting_started/install_guide
   getting_started/first_tutorial
   getting_started/reference
   getting_started/forum


.. toctree::
   :maxdepth: 2
   :caption: Surrogate Modeling and Analysis
   :hidden:

   sma/overview
   sma/doe
   sma/rsm
   sma/emulator
   sma/optimizer
   sma/sa
   sma/fprop
   sma/wizard
   sma/examples


.. toctree::
   :maxdepth: 2
   :caption: For Developers
   :hidden:

   developers/defaultnodes
   developers/nodedoc
   developers/node_examples
   developers/nodewidget_examples
   developers/develop
   developers/api
   developers/contributors


.. toctree::
   :maxdepth: 2
   :caption: Appendices
   :hidden:

   appx/sma_theory

.. toctree::
   :maxdepth: 2
   :caption: Other
   :hidden:

   Nodeworks-MFiX Plugin Documentation <https://mfix.netl.doe.gov/doc/nodeworks/latest/mfix_plugin>
   MFiX Documentation <https://mfix.netl.doe.gov/doc/mfix/latest/>


.. _pyqtgraph: http://www.pyqtgraph.org/
.. _Blender: https://www.blender.org/
.. _US Department of Energy's (DOE) National Energy Technology Laboratory (NETL): http://netl.doe.gov/