.. Bamboo documentation master file, created by
   sphinx-quickstart on Tue Feb 23 23:43:31 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Bamboo's documentation! 
==================================

Use the sidebar (on the left) to find lists of all the available classes and functions, for each submodule.
Use the 'home' buttons (with the small image of a house) to navigate back to this main page.

.. autosummary:: 
   :toctree: _autosummary
   :recursive:
    
    cusfbamboo.engine
    cusfbamboo.plot
    cusfbamboo.materials
    cusfbamboo.rao
    cusfbamboo.isen
    cusfbamboo.hx
    cusfbamboo.circuit

cusfbamboo.engine module
------------------
.. automodule:: cusfbamboo.engine
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource

cusfbamboo.plot module
---------------------
.. automodule:: cusfbamboo.plot
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource

cusfbamboo.materials module
------------------
.. automodule:: cusfbamboo.materials
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource

cusfbamboo.rao module
------------------
.. automodule:: cusfbamboo.rao
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource

cusfbamboo.isen module
------------------
.. automodule:: cusfbamboo.isen
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource

cusfbamboo.hx module
------------------
.. automodule:: cusfbamboo.hx
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource


cusfbamboo.circuit module
------------------
.. automodule:: cusfbamboo.circuit
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource

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

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