API Reference
=============

.. toctree::
   :maxdepth: 4

   finsim

finsim package
==============

.. automodule:: finsim
   :members:
   :undoc-members:
   :show-inheritance:

Subpackages
-----------

.. toctree::
   :maxdepth: 4

   finsim.data
   finsim.estimate
   finsim.portfolio
   finsim.simulation
   finsim.tech
   finsim.retrieve_stock_symbols_cli

finsim.data package
===================

.. automodule:: finsim.data
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.data.finnhub module
--------------------------

.. automodule:: finsim.data.finnhub
   :members:
   :undoc-members:
   :show-inheritance:

finsim.data.preader module
--------------------------

.. automodule:: finsim.data.preader
   :members:
   :undoc-members:
   :show-inheritance:

finsim.data.quandl module
-------------------------

.. automodule:: finsim.data.quandl
   :members:
   :undoc-members:
   :show-inheritance:

finsim.estimate package
=======================

.. automodule:: finsim.estimate
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.estimate.fit module
--------------------------

.. automodule:: finsim.estimate.fit
   :members:
   :undoc-members:
   :show-inheritance:

finsim.estimate.risk module
----------------------------

.. automodule:: finsim.estimate.risk
   :members:
   :undoc-members:
   :show-inheritance:

finsim.estimate.constants module
--------------------------------

.. automodule:: finsim.estimate.constants
   :members:
   :undoc-members:
   :show-inheritance:

Subpackages
-----------

finsim.estimate.native package
==============================

.. automodule:: finsim.estimate.native
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.estimate.native.pyfit module
------------------------------------

.. automodule:: finsim.estimate.native.pyfit
   :members:
   :undoc-members:
   :show-inheritance:

finsim.estimate.native.pyrisk module
-------------------------------------

.. automodule:: finsim.estimate.native.pyrisk
   :members:
   :undoc-members:
   :show-inheritance:

finsim.portfolio package
========================

.. automodule:: finsim.portfolio
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.portfolio.create module
------------------------------

.. automodule:: finsim.portfolio.create
   :members:
   :undoc-members:
   :show-inheritance:

finsim.portfolio.dynamic module
-------------------------------

.. automodule:: finsim.portfolio.dynamic
   :members:
   :undoc-members:
   :show-inheritance:

finsim.portfolio.helper module
------------------------------

.. automodule:: finsim.portfolio.helper
   :members:
   :undoc-members:
   :show-inheritance:

finsim.portfolio.portfolio module
----------------------------------

.. automodule:: finsim.portfolio.portfolio
   :members:
   :undoc-members:
   :show-inheritance:

Subpackages
-----------

finsim.portfolio.optimize package
==================================

.. automodule:: finsim.portfolio.optimize
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.portfolio.optimize.metrics module
-----------------------------------------

.. automodule:: finsim.portfolio.optimize.metrics
   :members:
   :undoc-members:
   :show-inheritance:

finsim.portfolio.optimize.numerics module
------------------------------------------

.. automodule:: finsim.portfolio.optimize.numerics
   :members:
   :undoc-members:
   :show-inheritance:

finsim.portfolio.optimize.policy module
----------------------------------------

.. automodule:: finsim.portfolio.optimize.policy
   :members:
   :undoc-members:
   :show-inheritance:

Subpackages
-----------

finsim.portfolio.optimize.native package
=========================================

.. automodule:: finsim.portfolio.optimize.native
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.portfolio.optimize.native.pymetrics module
-------------------------------------------------

.. automodule:: finsim.portfolio.optimize.native.pymetrics
   :members:
   :undoc-members:
   :show-inheritance:

finsim.simulation package
=========================

.. automodule:: finsim.simulation
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.simulation.stock module
------------------------------

.. automodule:: finsim.simulation.stock
   :members:
   :undoc-members:
   :show-inheritance:

finsim.tech package
===================

.. automodule:: finsim.tech
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.tech.ma module
----------------------

.. automodule:: finsim.tech.ma
   :members:
   :undoc-members:
   :show-inheritance:

finsim.retrieve\_stock\_symbols\_cli package
============================================

.. automodule:: finsim.retrieve_stock_symbols_cli
   :members:
   :undoc-members:
   :show-inheritance:

Submodules
----------

finsim.retrieve\_stock\_symbols\_cli.cli module
-----------------------------------------------

.. automodule:: finsim.retrieve_stock_symbols_cli.cli
   :members:
   :undoc-members:
   :show-inheritance: