.. Spine Toolbox documentation master file, created by
   sphinx-quickstart on Mon Jun 18 12:58:32 2018.

Welcome to Spine Toolbox's User Guide!
======================================

.. image:: img/spinetoolbox_on_wht.svg
   :align: center
   :scale: 30%

`Spine Toolbox <https://github.com/spine-tools/Spine-Toolbox>`_ is an application,
which provides means to define, manage, and execute complex data processing and
computation workflows, such as energy system models.

If you are new to Spine Toolbox, :ref:`Getting Started` section is a good place to start. If you want to run
`SpineOpt.jl <https://github.com/spine-tools/SpineOpt.jl>`_ using Spine Toolbox, :ref:`How to Set up SpineOpt.jl`
provides step-by-step instructions on how to get started. For information on how to set up Python, Julia, or
Gams for Spine Toolbox, see :ref:`Setting up Consoles and External Tools`. Please see :ref:`Settings` chapter for information
on user customizable Spine Toolbox settings. If you need help in understanding the terms we use throughout the app
and this User Guide, please check the :ref:`Terminology` section. If you want to contribute to this project,
please see the :ref:`Contribution Guide`. The last section contains the complete code reference of Spine Toolbox.

.. toctree::
   :maxdepth: 1
   :caption: Contents:

   whats_new
   getting_started
   how_to_run_spineopt
   setting_up
   main_window
   project_items
   links_and_loops
   tool_specification_editor
   executing_projects
   scenarios_and_alternatives
   settings
   project_settings
   Spine Database Editor <spine_db_editor/index>
   plotting
   parameter_value_editor
   data_import_export
   spine_engine_server
   best_practices
   terminology
   contribution_guide
   developer_documentation

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`