.. py:currentmodule:: mhi.enerplot

===========
Enerplot
===========

----------------
Launch & Connect
----------------

.. autofunction:: mhi.enerplot.application

.. autofunction:: mhi.enerplot.connect

.. autofunction:: mhi.enerplot.launch

.. autofunction:: mhi.enerplot.versions

------------------
Application Object
------------------

.. autoclass:: mhi.enerplot.Enerplot


Properties
==========

.. autoattribute:: Enerplot.version
.. autoattribute:: Enerplot.examples

.. automethod:: Enerplot.substitute


Workspace
=========

.. automethod:: mhi.enerplot.Enerplot.new_workspace

.. automethod:: mhi.enerplot.Enerplot.load_workspace

.. automethod:: mhi.enerplot.Enerplot.reload

.. automethod:: mhi.enerplot.Enerplot.save_workspace

.. automethod:: mhi.enerplot.Enerplot.save_workspace_as

.. automethod:: mhi.enerplot.Enerplot.is_dirty

.. autoattribute:: Enerplot.workspace_dir
.. autoattribute:: Enerplot.workspace_name
.. autoattribute:: Enerplot.workspace_path


Books
=====

.. automethod:: mhi.enerplot.Enerplot.load_books

.. automethod:: mhi.enerplot.Enerplot.new_book

.. automethod:: mhi.enerplot.Enerplot.books

.. automethod:: mhi.enerplot.Enerplot.book


Data Files
==========

.. automethod:: mhi.enerplot.Enerplot.load_datafiles

.. automethod:: mhi.enerplot.Enerplot.new_datafile

.. automethod:: mhi.enerplot.Enerplot.datafiles

.. automethod:: mhi.enerplot.Enerplot.datafile


Status & Progress
=================

The status bar at the bottom of the application is used to give feedback to the user
about the progress of various operations as well as the final results.
The following functions grant a script access to this feedback.

.. automethod:: mhi.enerplot.Enerplot.status

.. automethod:: mhi.enerplot.Enerplot.progress

.. autoclass:: mhi.enerplot.Progress
	:members:
