.. _User Guide:

User Guide
==========

This user guide has been adapted from the interactive tutorial notebooks that can be found in any Seeq Data Lab
project in the "SPy Documentation" folder. If you wish to follow along with these notebooks in an environment other
than Seeq Data Lab, run the command ``spy.docs.copy()`` in your Python environment to create a new folder containing a
copy of these notebooks.

If you have not used the SPy module before, we recommend starting with the :doc:`tutorial<Tutorial>` before
continuing to the guides for the SPy function(s) you wish to use, e.g., :doc:`spy.push<spy.push>`.

.. toctree::
   :maxdepth: 3
   :caption: Contents:

   Tutorial <Tutorial.rst>
   spy.login <spy.login.rst>
   spy.search <spy.search.rst>
   spy.push <spy.push.rst>
   spy.pull <spy.pull.rst>
   spy.swap <spy.swap.rst>
   Asset Trees 1 - Introduction <Asset Trees 1 - Introduction.rst>
   Asset Trees 2 - Templates <Asset Trees 2 - Templates.rst>
   Asset Trees 3 - Report and Dashboard Templates <Asset Trees 3 - Report and Dashboard Templates.rst>
   Asset Trees 4 - Accelerator Templates <Asset Trees 4 - Accelerator Templates.rst>
   spy.acl <spy.acl.rst>
   spy.workbooks <spy.workbooks.rst>
   Workbook Jobs <Workbook Jobs.rst>
   Workbook Templates <Workbook Templates.rst>
   Data Lab Visualizations <Data Lab Visualizations.rst>
   spy.jobs <spy.jobs.rst>
   Advanced Scheduling <Advanced Scheduling/index.rst>
   spy.widgets <spy.widgets.rst>
   Timezones in SPy <timezones.rst>
   Version Considerations <Version Considerations.rst>