openseries.ReturnSimulation
===========================

.. currentmodule:: openseries

.. autoclass:: ReturnSimulation

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~ReturnSimulation.__init__
      ~ReturnSimulation.construct
      ~ReturnSimulation.copy
      ~ReturnSimulation.dict
      ~ReturnSimulation.from_gbm
      ~ReturnSimulation.from_lognormal
      ~ReturnSimulation.from_merton_jump_gbm
      ~ReturnSimulation.from_normal
      ~ReturnSimulation.from_orm
      ~ReturnSimulation.json
      ~ReturnSimulation.model_construct
      ~ReturnSimulation.model_copy
      ~ReturnSimulation.model_dump
      ~ReturnSimulation.model_dump_json
      ~ReturnSimulation.model_json_schema
      ~ReturnSimulation.model_parametrized_name
      ~ReturnSimulation.model_post_init
      ~ReturnSimulation.model_rebuild
      ~ReturnSimulation.model_validate
      ~ReturnSimulation.model_validate_json
      ~ReturnSimulation.model_validate_strings
      ~ReturnSimulation.parse_file
      ~ReturnSimulation.parse_obj
      ~ReturnSimulation.parse_raw
      ~ReturnSimulation.schema
      ~ReturnSimulation.schema_json
      ~ReturnSimulation.to_dataframe
      ~ReturnSimulation.update_forward_refs
      ~ReturnSimulation.validate
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~ReturnSimulation.model_computed_fields
      ~ReturnSimulation.model_config
      ~ReturnSimulation.model_extra
      ~ReturnSimulation.model_fields
      ~ReturnSimulation.model_fields_set
      ~ReturnSimulation.realized_mean_return
      ~ReturnSimulation.realized_vol
      ~ReturnSimulation.results
      ~ReturnSimulation.number_of_sims
      ~ReturnSimulation.trading_days
      ~ReturnSimulation.trading_days_in_year
      ~ReturnSimulation.mean_annual_return
      ~ReturnSimulation.mean_annual_vol
      ~ReturnSimulation.dframe
      ~ReturnSimulation.jumps_lamda
      ~ReturnSimulation.jumps_sigma
      ~ReturnSimulation.jumps_mu
      ~ReturnSimulation.seed