Examples
========

The portfolioAnalytics packages offers quite a lot of functionality. Here we break down some of the main workflows for those getting started.

The examples directory includes Python scripts and Jupyter notebooks to help you get started

- Generating loss distributions analytically
- Estimating thresholds given a multi-period transition matrix set


Python Scripts
-------------------------------------------

Located in examples/python (For testing purposes all examples can be run using the run_examples.py script located in the root directory)

.. automodule:: examples.python
    :noindex:


.. toctree::

    examples.python.calculate_variance
    examples.python.portfolio_model
    examples.python.calculate_thresholds
    examples.python.visualize_thresholds
    examples.python.validate_thresholds



Jupyter Notebooks
-------------------------------------------

* Examples.ipynb
* Portfolio_Examples.ipynb


Open Risk Academy Scripts
-------------------------------------------

TODO