##################
Saving and Loading
##################
:class:`.TyphosSuite` objects can be stored for later use. The devices that
were loaded into the suite via :meth:`.TyphosSuite.add_device` will be added
once again assuming that they are stored in a ``happi`` database.

.. automethod:: typhos.TyphosSuite.save
   :noindex:

There are two major ways to use this created file:

1. Execute the Python file from the command line. This will route the call
   through the standard :mod:`typhos.cli` meaning all options
   described there are also available.

.. code:: bash

   $ python saved_suite.py


2. The ``create_suite`` method generated in the saved file can be used to
   re-create the :class:`.TyphosSuite` in an already running Python process.
   Typhos provides the :func:`.load_suite` function to import the provided
   Python file and execute the stored ``create_suite`` method.  This is useful
   if you want to use the file to embed a saved :class:`.TyphosSuite` inside
   another PyQt window for instance, or load multiple suites at once.


.. code:: python

   from qtpy.QtWidgets import QApplication
   from typhos import load_suite

   app = QApplication([])
   saved_suite = load_suite('saved_suite.py')

   saved_suite.show()
   app.exec_()


.. note::

   The saved file only stores a reference to the devices loaded into the
   ``TyphosSuite`` by name. It is assumed that these devices will be available
   under the same name via the configured ``happi`` database when
   ``load_suite`` is called. If the device has a different name in the database
   or you have configured a different ``happi`` database to be used your
   devices will not be loaded properly.