Sympathy for Data
=================

Welcome to the documentation for *Sympathy for Data*.

:Project page: `https://www.sympathyfordata.com <https://www.sympathyfordata.com>`_
:Author: `System Engineering Software Society (SysESS) <http://www.sysess.org/>`_


Getting started
---------------
Want to learn more about what Sympathy for Data is and what it can do for you?

.. toctree::
   :maxdepth: 2
   :caption: Getting started

   src/about_sympathy.rst
   src/installation.rst
   src/first_steps.rst


Important Concepts
------------------

.. toctree::
   :maxdepth: 2
   :caption: Important Concepts

   src/concepts.rst
   src/subflows.rst
   src/functions.rst


Graphical user interface
------------------------

.. toctree::
   :maxdepth: 2
   :caption: Graphical user interface

   src/gui.rst
   src/viewer.rst

Command line options
--------------------

.. toctree::
   :maxdepth: 2
   :caption: Command line options

   src/batch.rst


Development
-----------
Learn how to write nodes and more.

.. toctree::
   :maxdepth: 2
   :caption: Development

   src/nodewriting.rst
   src/advanced_nodewriting.rst
   src/debugging_nodes.rst
   src/pluginwriting.rst
   src/library.rst
   src/create_type.rst
   src/python3.rst
   src/interactive.rst


API Reference
-------------

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   src/node_reference.rst
   src/parameter_helper_reference.rst
   src/type_apis.rst


.. _Library:

Libraries
---------
Documentation for each type of node in the standard library of Sympathy for
Data as well as in any third-party libraries. Right-clicking on any node in the
GUI and choosing *Help* will bring you to the help page for that specific node.

.. toctree::
   :maxdepth: 2
   :caption: Libraries

   src/typical_workflow_structure.rst

   src/machinelearning.rst

   src/Library/index.rst


Changes
-------

.. toctree::
   :maxdepth: 2
   :caption: Changes

   src/news.rst
   src/deprecations.rst


Appendix
--------

.. toctree::
   :maxdepth: 2
   :caption: Appendix

   src/appendix.rst