openseries package
==================

The openseries package provides two main classes for financial time series analysis:

- **OpenTimeSeries**: For single financial time series analysis
- **OpenFrame**: For multi-asset portfolio analysis and comparison

Both classes inherit from the private ``_CommonModel`` class, which in turn inherits from Pydantic's ``BaseModel``. This inheritance structure provides:

- **Data validation** through Pydantic's validation system
- **Common functionality** shared between both classes (risk metrics, plotting, data handling)
- **Type safety** and consistent API design

The ``_CommonModel`` class contains all the shared methods and properties that both ``OpenTimeSeries`` and ``OpenFrame`` use, including risk calculations, plotting capabilities, and data manipulation functions.

Main Classes
------------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.OpenTimeSeries
   openseries.OpenFrame

Utility Functions
-----------------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.timeseries_chain
   openseries.report_html

Portfolio Tools
---------------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.efficient_frontier
   openseries.simulate_portfolios
   openseries.constrain_optimized_portfolios
   openseries.prepare_plot_data
   openseries.sharpeplot

Date Utilities
--------------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.date_fix
   openseries.date_offset_foll
   openseries.generate_calendar_date_range
   openseries.get_previous_business_day_before_today
   openseries.holiday_calendar
   openseries.offset_business_days

Simulation
----------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.ReturnSimulation

Types and Enums
---------------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.ValueType

Other Utilities
---------------

.. autosummary::
   :toctree: generated/
   :nosignatures:

   openseries.load_plotly_dict
   openseries.export_plotly_figure