stochvolmodels 1.1.1__tar.gz → 1.1.2__tar.gz

{stochvolmodels-1.1.1/stochvolmodels.egg-info → stochvolmodels-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stochvolmodels
-Version: 1.1.1
+Version: 1.1.2
 Summary: Python implementation of pricing analytics and Monte Carlo simulations for stochastic volatility models including log-normal SV model, Heston
 Author-email: Artur Sepp <artursepp@gmail.com>
 Maintainer-email: Artur Sepp <artursepp@gmail.com>, Parviz Rakhmonov <ParvizRZ@gmail.com>
@@ -779,7 +779,7 @@ Dynamic: license-file
 The StochVol package provides:
 1) Analytics for Black-Scholes and Normal vols
 2) Interfaces and implementation for stochastic volatility models,
-including log-normal SV model and Heston SV model 
+including Karasinski-Sepp log-normal SV model and Heston SV model 
 using analytical method with Fourier transform and Monte Carlo simulations
 3) Visualization of model implied volatilities
 
@@ -808,17 +808,18 @@ Close using
 git clone https://github.com/ArturSepp/StochVolModels.git
 ```
 
-Core dependencies:
-    python = ">=3.8",
-    numba = ">=0.56.4",
-    numpy = ">=1.22.4",
-    scipy = ">=1.10",
-    pandas = ">=2.2.0",
-    matplotlib = ">=3.2.2",
-    seaborn = ">=0.12.2"
+
+### Core Dependencies
+- `python >= 3.8`
+- `numba >= 0.56.4`
+- `numpy >= 1.22.4`
+- `scipy >= 1.10`
+- `pandas >= 2.2.0`
+- `matplotlib >= 3.2.2`
+- `seaborn >= 0.12.2`
 
 Optional dependencies:
-    qis ">=2.1.38" (for running code in my_papers)
+    qis ">=2.3.1" (for running code in my_papers)
 
 
 # Table of contents
@@ -846,7 +847,7 @@ The model interface is in stochvolmodels/pricers/model_pricer.py
 
 ### Log-normal stochastic volatility model <a name="logsv"></a>
 
-The analytics for the log-normal stochastic volatility model is based on the paper
+The analytics for Karasinki-Sepp log-normal stochastic volatility model is based on the paper
 
 [Log-normal Stochastic Volatility Model with Quadratic Drift](https://www.worldscientific.com/doi/10.1142/S0219024924500031) by Artur Sepp and Parviz Rakhmonov
 
@@ -1039,3 +1040,107 @@ https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4646925
 stochvolmodels/my_papers/sv_for_factor_hjm
 ```
 
+## Project Structure
+
+```
+StochVolModels/
+├── stochvolmodels/
+│   ├── pricers/
+│   │   ├── model_pricer.py         # Generic model interface
+│   │   ├── logsv_pricer.py         # Log-normal SV implementation  
+│   │   └── heston_pricer.py        # Heston SV implementation
+│   ├── data/
+│   │   └── option_chain.py         # Option chain data structures
+│   └── my_papers/                  # Research paper implementations
+│       ├── logsv_model_with_quadratic_drift/
+│       ├── volatility_models/
+│       ├── inverse_options/
+│       ├── il_hedging/
+│       └── sv_for_factor_hjm/
+├── examples/
+│   ├── run_lognormal_sv_pricer.py
+│   ├── run_heston_sv_pricer.py
+│   ├── run_heston.py
+│   └── plots_for_paper/
+└── README.md
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this package in your research, please cite the relevant papers:
+
+```bibtex
+@misc{sepp2024stochvolmodels,
+  title={StochVolModels: Python Implementation of Stochastic Volatility Models},
+  author={Sepp, Artur},
+  year={2024},
+  howpublished={\url{https://github.com/ArturSepp/StochVolModels}},
+  note={Python package for pricing analytics and Monte Carlo simulations}
+}
+
+@article{sepprakhmonov2023,
+title={Log-normal stochastic volatility model with quadratic drift},
+author={Sepp, Artur and Rakhmonov, Parviz},
+journal={International Journal of Theoretical and Applied Finance},
+volume={26},
+number={8},
+year={2023},
+url={https://www.worldscientific.com/doi/epdf/10.1142/S0219024924500031}
+}
+
+@article{sepprakhmonov2023b,
+title={What is a robust stochastic volatility model},
+author={Sepp, Artur and Rakhmonov, Parviz},
+year={2023},
+note={Working paper},
+url={http://ssrn.com/abstract=4647027}
+}
+
+@article{lucicsepp2024,
+title={Valuation and hedging of cryptocurrency inverse options},
+author={Lucic, Vladimir and Sepp, Artur},
+journal={Quantitative Finance},
+volume={24},
+number={7},
+pages={851--869},
+year={2024},
+url={https://www.tandfonline.com/doi/full/10.1080/14697688.2024.2364804}
+}
+
+@article{lucicsepp2024,
+title={Valuation and hedging of cryptocurrency inverse options},
+author={Lucic, Vladimir and Sepp, Artur},
+journal={Quantitative Finance},
+volume={24},
+number={7},
+pages={851--869},
+year={2024},
+url={https://www.tandfonline.com/doi/full/10.1080/14697688.2024.2364804}
+}
+
+@article{sepprakhmonov2024,
+title={Stochastic volatility for factor Heath-Jarrow-Morton framework},
+author={Sepp, Artur and Rakhmonov, Parviz},
+year={2025},
+journal={Review of Derivatives Research},
+note={Accepted},
+url={http://ssrn.com/abstract=4646925}
+}
+```
+
+## Acknowledgments
+
+Special thanks to co-authors and collaborators:
+- Parviz Rakhmonov  
+- Vladimir Lucic
+- Alexander Lipton
+
+For additional research and advanced analytics, see the companion modules and papers included in this package.

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/README.md

@@ -27,7 +27,7 @@
 The StochVol package provides:
 1) Analytics for Black-Scholes and Normal vols
 2) Interfaces and implementation for stochastic volatility models,
-including log-normal SV model and Heston SV model 
+including Karasinski-Sepp log-normal SV model and Heston SV model 
 using analytical method with Fourier transform and Monte Carlo simulations
 3) Visualization of model implied volatilities
 
@@ -56,17 +56,18 @@ Close using
 git clone https://github.com/ArturSepp/StochVolModels.git
 ```
 
-Core dependencies:
-    python = ">=3.8",
-    numba = ">=0.56.4",
-    numpy = ">=1.22.4",
-    scipy = ">=1.10",
-    pandas = ">=2.2.0",
-    matplotlib = ">=3.2.2",
-    seaborn = ">=0.12.2"
+
+### Core Dependencies
+- `python >= 3.8`
+- `numba >= 0.56.4`
+- `numpy >= 1.22.4`
+- `scipy >= 1.10`
+- `pandas >= 2.2.0`
+- `matplotlib >= 3.2.2`
+- `seaborn >= 0.12.2`
 
 Optional dependencies:
-    qis ">=2.1.38" (for running code in my_papers)
+    qis ">=2.3.1" (for running code in my_papers)
 
 
 # Table of contents
@@ -94,7 +95,7 @@ The model interface is in stochvolmodels/pricers/model_pricer.py
 
 ### Log-normal stochastic volatility model <a name="logsv"></a>
 
-The analytics for the log-normal stochastic volatility model is based on the paper
+The analytics for Karasinki-Sepp log-normal stochastic volatility model is based on the paper
 
 [Log-normal Stochastic Volatility Model with Quadratic Drift](https://www.worldscientific.com/doi/10.1142/S0219024924500031) by Artur Sepp and Parviz Rakhmonov
 
@@ -287,3 +288,107 @@ https://papers.ssrn.com/sol3/papers.cfm?abstract_id=4646925
 stochvolmodels/my_papers/sv_for_factor_hjm
 ```
 
+## Project Structure
+
+```
+StochVolModels/
+├── stochvolmodels/
+│   ├── pricers/
+│   │   ├── model_pricer.py         # Generic model interface
+│   │   ├── logsv_pricer.py         # Log-normal SV implementation  
+│   │   └── heston_pricer.py        # Heston SV implementation
+│   ├── data/
+│   │   └── option_chain.py         # Option chain data structures
+│   └── my_papers/                  # Research paper implementations
+│       ├── logsv_model_with_quadratic_drift/
+│       ├── volatility_models/
+│       ├── inverse_options/
+│       ├── il_hedging/
+│       └── sv_for_factor_hjm/
+├── examples/
+│   ├── run_lognormal_sv_pricer.py
+│   ├── run_heston_sv_pricer.py
+│   ├── run_heston.py
+│   └── plots_for_paper/
+└── README.md
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Citation
+
+If you use this package in your research, please cite the relevant papers:
+
+```bibtex
+@misc{sepp2024stochvolmodels,
+  title={StochVolModels: Python Implementation of Stochastic Volatility Models},
+  author={Sepp, Artur},
+  year={2024},
+  howpublished={\url{https://github.com/ArturSepp/StochVolModels}},
+  note={Python package for pricing analytics and Monte Carlo simulations}
+}
+
+@article{sepprakhmonov2023,
+title={Log-normal stochastic volatility model with quadratic drift},
+author={Sepp, Artur and Rakhmonov, Parviz},
+journal={International Journal of Theoretical and Applied Finance},
+volume={26},
+number={8},
+year={2023},
+url={https://www.worldscientific.com/doi/epdf/10.1142/S0219024924500031}
+}
+
+@article{sepprakhmonov2023b,
+title={What is a robust stochastic volatility model},
+author={Sepp, Artur and Rakhmonov, Parviz},
+year={2023},
+note={Working paper},
+url={http://ssrn.com/abstract=4647027}
+}
+
+@article{lucicsepp2024,
+title={Valuation and hedging of cryptocurrency inverse options},
+author={Lucic, Vladimir and Sepp, Artur},
+journal={Quantitative Finance},
+volume={24},
+number={7},
+pages={851--869},
+year={2024},
+url={https://www.tandfonline.com/doi/full/10.1080/14697688.2024.2364804}
+}
+
+@article{lucicsepp2024,
+title={Valuation and hedging of cryptocurrency inverse options},
+author={Lucic, Vladimir and Sepp, Artur},
+journal={Quantitative Finance},
+volume={24},
+number={7},
+pages={851--869},
+year={2024},
+url={https://www.tandfonline.com/doi/full/10.1080/14697688.2024.2364804}
+}
+
+@article{sepprakhmonov2024,
+title={Stochastic volatility for factor Heath-Jarrow-Morton framework},
+author={Sepp, Artur and Rakhmonov, Parviz},
+year={2025},
+journal={Review of Derivatives Research},
+note={Accepted},
+url={http://ssrn.com/abstract=4646925}
+}
+```
+
+## Acknowledgments
+
+Special thanks to co-authors and collaborators:
+- Parviz Rakhmonov  
+- Vladimir Lucic
+- Alexander Lipton
+
+For additional research and advanced analytics, see the companion modules and papers included in this package.

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "stochvolmodels"
-version = "1.1.1"
+version = "1.1.2"
 description = "Python implementation of pricing analytics and Monte Carlo simulations for stochastic volatility models including log-normal SV model, Heston"
 readme = "README.md"
 license = {file = "LICENSE.txt"}

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/stochvolmodels/data/fetch_option_chain.py

@@ -117,13 +117,18 @@ def load_price_data(options_data_dfs: OptionsDataDFs,
     return spot_price
 
 
-class UnitTests(Enum):
+class LocalTests(Enum):
     PRINT_CHAIN_DATA = 1
     GENERATE_VOL_CHAIN_NP = 2
     SAMPLE_CHAIN_AT_TIMES = 3
 
 
-def run_unit_test(unit_test: UnitTests):
+def run_local_test(local_test: LocalTests):
+    """Run local tests for development and debugging purposes.
+
+    These are integration tests that download real data and generate reports.
+    Use for quick verification during development.
+    """
 
     ticker = 'BTC'  # BTC, ETH
     value_time = pd.Timestamp('2021-10-21 08:00:00+00:00')
@@ -134,11 +139,11 @@ def run_unit_test(unit_test: UnitTests):
     options_data_dfs.get_start_end_date().print()
     chain = create_chain_from_from_options_dfs(options_data_dfs=options_data_dfs, value_time=value_time)
 
-    if unit_test == UnitTests.PRINT_CHAIN_DATA:
+    if local_test == LocalTests.PRINT_CHAIN_DATA:
         for expiry, eslice in chain.expiry_slices.items():
             eslice.print()
 
-    elif unit_test == UnitTests.GENERATE_VOL_CHAIN_NP:
+    elif local_test == LocalTests.GENERATE_VOL_CHAIN_NP:
         option_chain = generate_vol_chain_np(chain=chain,
                                              value_time=value_time,
                                              days_map={'1w': 7},
@@ -148,7 +153,7 @@ def run_unit_test(unit_test: UnitTests):
         skews = option_chain.get_chain_skews(delta=0.35)
         print(skews)
 
-    elif unit_test == UnitTests.SAMPLE_CHAIN_AT_TIMES:
+    elif local_test == LocalTests.SAMPLE_CHAIN_AT_TIMES:
         time_period = qis.TimePeriod('01Jan2023', '31Jan2023', tz='UTC')
         option_chains = sample_option_chain_at_times(options_data_dfs=options_data_dfs,
                                                      time_period=time_period,
@@ -164,11 +169,4 @@ def run_unit_test(unit_test: UnitTests):
 
 if __name__ == '__main__':
 
-    unit_test = UnitTests.SAMPLE_CHAIN_AT_TIMES
-
-    is_run_all_tests = False
-    if is_run_all_tests:
-        for unit_test in UnitTests:
-            run_unit_test(unit_test=unit_test)
-    else:
-        run_unit_test(unit_test=unit_test)
+    run_local_test(local_test=LocalTests.SAMPLE_CHAIN_AT_TIMES)

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/stochvolmodels/data/test_option_chain.py

@@ -871,7 +871,7 @@ def get_qv_options_test_chain_data(num_strikes: int = 21) -> OptionChain:
     return data
 
 
-class UnitTests(Enum):
+class LocalTests(Enum):
     BTC = 1
     VIX = 2
     GLD = 3
@@ -879,36 +879,34 @@ class UnitTests(Enum):
     SPY = 5
 
 
-def run_unit_test(unit_test: UnitTests):
+def run_local_test(local_test: LocalTests):
+    """Run local tests for development and debugging purposes.
 
-    if unit_test == UnitTests.BTC:
+    These are integration tests that download real data and generate reports.
+    Use for quick verification during development.
+    """
+
+    if local_test == LocalTests.BTC:
         option_chain = get_btc_test_chain_data()
         print(option_chain)
 
-    elif unit_test == UnitTests.VIX:
+    elif local_test == LocalTests.VIX:
         option_chain = get_vix_test_chain_data()
         print(option_chain)
 
-    elif unit_test == UnitTests.GLD:
+    elif local_test == LocalTests.GLD:
         option_chain = get_gld_test_chain_data()
         print(option_chain)
 
-    elif unit_test == UnitTests.SQQQ:
+    elif local_test == LocalTests.SQQQ:
         option_chain = get_sqqq_test_chain_data()
         print(option_chain)
 
-    elif unit_test == UnitTests.SPY:
+    elif local_test == LocalTests.SPY:
         option_chain = get_spy_test_chain_data()
         print(option_chain)
 
 
 if __name__ == '__main__':
 
-    unit_test = UnitTests.BTC
-
-    is_run_all_tests = False
-    if is_run_all_tests:
-        for unit_test in UnitTests:
-            run_unit_test(unit_test=unit_test)
-    else:
-        run_unit_test(unit_test=unit_test)
+    run_local_test(local_test=LocalTests.BTC)

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/stochvolmodels/examples/run_lognormal_sv_pricer.py

@@ -9,7 +9,7 @@ import stochvolmodels as sv
 from stochvolmodels import LogSVPricer, LogSvParams, OptionChain, LogsvModelCalibrationType
 
 
-class UnitTests(Enum):
+class LocalTests(Enum):
     COMPUTE_MODEL_PRICES = 1
     PLOT_MODEL_IMPLIED_VOLS = 2
     PLOT_MODEL_VOLS_IN_PARAMS = 3
@@ -22,7 +22,12 @@ class UnitTests(Enum):
     BENCHM_ROUGH_PRICER = 10
 
 
-def run_unit_test(unit_test: UnitTests):
+def run_local_test(local_test: LocalTests):
+    """Run local tests for development and debugging purposes.
+
+    These are integration tests that download real data and generate reports.
+    Use for quick verification during development.
+    """
 
     # instance of pricer
     logsv_pricer = LogSVPricer()
@@ -30,7 +35,7 @@ def run_unit_test(unit_test: UnitTests):
     # define model params    
     params = LogSvParams(sigma0=1.0, theta=1.0, kappa1=5.0, kappa2=5.0, beta=0.2, volvol=2.0)
 
-    if unit_test == UnitTests.COMPUTE_MODEL_PRICES:
+    if local_test == LocalTests.COMPUTE_MODEL_PRICES:
         # 1. one price
         model_price, vol = logsv_pricer.price_vanilla(params=params,
                                                       ttm=0.25,
@@ -55,7 +60,7 @@ def run_unit_test(unit_test: UnitTests):
         print(model_prices)
         print(vols)
 
-    elif unit_test == UnitTests.PLOT_MODEL_IMPLIED_VOLS:
+    elif local_test == LocalTests.PLOT_MODEL_IMPLIED_VOLS:
         # define uniform option chain
         option_chain = OptionChain.get_uniform_chain(ttms=np.array([0.083, 0.25]),
                                                      ids=np.array(['1m', '3m']),
@@ -63,7 +68,7 @@ def run_unit_test(unit_test: UnitTests):
         logsv_pricer.plot_model_ivols(option_chain=option_chain,
                                       params=params)
 
-    elif unit_test == UnitTests.PLOT_MODEL_VOLS_IN_PARAMS:
+    elif local_test == LocalTests.PLOT_MODEL_VOLS_IN_PARAMS:
 
         # define uniform option chain
         option_chain = OptionChain.get_uniform_chain(ttms=np.array([0.083, 0.25]),
@@ -79,7 +84,7 @@ def run_unit_test(unit_test: UnitTests):
         logsv_pricer.plot_model_slices_in_params(option_slice=option_slice,
                                                  params_dict=params_dict)
 
-    elif unit_test == UnitTests.COMPARE_MODEL_VOLS_TO_MC:
+    elif local_test == LocalTests.COMPARE_MODEL_VOLS_TO_MC:
         btc_option_chain = sv.get_btc_test_chain_data()
         uniform_chain_data = OptionChain.to_uniform_strikes(obj=btc_option_chain, num_strikes=31)
         btc_calibrated_params = LogSvParams(sigma0=0.8327, theta=1.0139, kappa1=4.8609, kappa2=4.7940, beta=0.1988, volvol=2.3694)
@@ -92,13 +97,13 @@ def run_unit_test(unit_test: UnitTests):
                                                            params=btc_calibrated_params,
                                                            nb_path=100000)
 
-    elif unit_test == UnitTests.PLOT_FIT_TO_BITCOIN_OPTION_CHAIN:
+    elif local_test == LocalTests.PLOT_FIT_TO_BITCOIN_OPTION_CHAIN:
         btc_option_chain = sv.get_btc_test_chain_data()
         btc_calibrated_params = LogSvParams(sigma0=0.8327, theta=1.0139, kappa1=4.8609, kappa2=4.7940, beta=0.1988, volvol=2.3694)
         logsv_pricer.plot_model_ivols_vs_bid_ask(option_chain=btc_option_chain,
                                                  params=btc_calibrated_params)
 
-    elif unit_test == UnitTests.MC_WITH_FIXED_RANDOMS:
+    elif local_test == LocalTests.MC_WITH_FIXED_RANDOMS:
         btc_option_chain = sv.get_btc_test_chain_data()
         W0s, W1s, dts = sv.get_randoms_for_chain_valuation(ttms=btc_option_chain.ttms,
                                                            nb_path=10000,
@@ -126,7 +131,7 @@ def run_unit_test(unit_test: UnitTests):
         print(option_prices_ttm)
 
 
-    elif unit_test == UnitTests.ROUGH_MC_WITH_FIXED_RANDOMS:
+    elif local_test == LocalTests.ROUGH_MC_WITH_FIXED_RANDOMS:
         btc_option_chain = sv.get_btc_test_chain_data()
         Z0, Z1, grid_ttms = sv.get_randoms_for_rough_vol_chain_valuation(ttms=btc_option_chain.ttms,
                                                                              nb_path=10000,
@@ -154,7 +159,7 @@ def run_unit_test(unit_test: UnitTests):
                                                                                          timegrids=grid_ttms)
         print(option_prices_ttm)
 
-    elif unit_test == UnitTests.BENCHM_ROUGH_PRICER:
+    elif local_test == LocalTests.BENCHM_ROUGH_PRICER:
         btc_option_chain = OptionChain.get_uniform_chain(ttms=np.array([0.083, 0.25]),
                                                      ids=np.array(['1m', '3m']),
                                                      strikes=np.linspace(0.5, 1.5, 21))
@@ -234,7 +239,7 @@ def run_unit_test(unit_test: UnitTests):
         fig.suptitle(f"Conventional LogSV model vs Rough LogSV, H={H:.2f} via {N}f Markovian approximation",
                      color="darkblue")
 
-    elif unit_test == UnitTests.CALIBRATE_MODEL_TO_BTC_OPTIONS:
+    elif local_test == LocalTests.CALIBRATE_MODEL_TO_BTC_OPTIONS:
         btc_option_chain = sv.get_btc_test_chain_data()
         params0 = LogSvParams(sigma0=0.8, theta=1.0, kappa1=2.21, kappa2=2.18, beta=0.15, volvol=2.0)
         btc_calibrated_params = logsv_pricer.calibrate_model_params_to_chain(option_chain=btc_option_chain,
@@ -245,7 +250,7 @@ def run_unit_test(unit_test: UnitTests):
         logsv_pricer.plot_model_ivols_vs_bid_ask(option_chain=btc_option_chain,
                                                  params=btc_calibrated_params)
 
-    elif unit_test == UnitTests.CALIBRATE_MODEL_TO_BTC_OPTIONS_WITH_MC:
+    elif local_test == LocalTests.CALIBRATE_MODEL_TO_BTC_OPTIONS_WITH_MC:
         btc_option_chain = sv.get_btc_test_chain_data()
         params0 = LogSvParams(sigma0=0.8, theta=1.0, kappa1=2.21, kappa2=0.0, beta=0.15, volvol=2.0)
         params0.H = 0.3
@@ -266,11 +271,4 @@ def run_unit_test(unit_test: UnitTests):
 
 if __name__ == '__main__':
 
-    unit_test = UnitTests.BENCHM_ROUGH_PRICER
-
-    is_run_all_tests = False
-    if is_run_all_tests:
-        for unit_test in UnitTests:
-            run_unit_test(unit_test=unit_test)
-    else:
-        run_unit_test(unit_test=unit_test)
+    run_local_test(local_test=LocalTests.BENCHM_ROUGH_PRICER)

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/stochvolmodels/pricers/analytic/tdist.py

@@ -197,14 +197,19 @@ def infer_tdist_implied_vols_from_model_slice_prices(ttm: float,
     return model_vol_ttm
 
 
-class UnitTests(Enum):
+class LocalTests(Enum):
     PLOT_PDF = 1
     PLOT_CDF = 2
     PLOT_CUM_X = 3
     PLOT_H = 4
 
 
-def run_unit_test(unit_test: UnitTests):
+def run_local_test(local_test: LocalTests):
+    """Run local tests for development and debugging purposes.
+
+    These are integration tests that download real data and generate reports.
+    Use for quick verification during development.
+    """
 
     import qis as qis
 
@@ -215,7 +220,7 @@ def run_unit_test(unit_test: UnitTests):
                'mu=0.2, vol=0.2': (0.2, 0.2),
                'mu=0.2, vol=0.4': (0.2, 0.4)}
 
-    if unit_test == UnitTests.PLOT_PDF:
+    if local_test == LocalTests.PLOT_PDF:
         pdfs = {}
         for key, mu_vol in mu_vols.items():
             pdf = dx * pdf_tdist(x=x, mu=mu_vol[0], vol=mu_vol[1], nu=3.0, ttm=ttm)
@@ -224,7 +229,7 @@ def run_unit_test(unit_test: UnitTests):
         pdfs = pd.DataFrame.from_dict(pdfs, orient='columns')
         qis.plot_line(df=pdfs)
 
-    elif unit_test == UnitTests.PLOT_CDF:
+    elif local_test == LocalTests.PLOT_CDF:
         pdfs = {}
         cpdfs = {}
         for key, mu_vol in mu_vols.items():
@@ -238,7 +243,7 @@ def run_unit_test(unit_test: UnitTests):
         colors = qis.get_n_colors(n=len(mu_vols.keys()))
         qis.plot_line(df=df, colors=2*colors)
 
-    elif unit_test == UnitTests.PLOT_CUM_X:
+    elif local_test == LocalTests.PLOT_CUM_X:
         pdfs = {}
         cpdfs = {}
         for key, mu_vol in mu_vols.items():
@@ -252,7 +257,7 @@ def run_unit_test(unit_test: UnitTests):
         colors = qis.get_n_colors(n=len(mu_vols.keys()))
         qis.plot_line(df=df, colors=2*colors)
 
-    elif unit_test == UnitTests.PLOT_H:
+    elif local_test == LocalTests.PLOT_H:
         x = np.linspace(-10.0, 10.0, 2000)
         h = pd.Series(cum_mean_tdist(x=x, mu=0.5, vol=1.0, nu=3.0, ttm=1.0), index=x, name='h')
         qis.plot_line(df=h, xlabel='x')
@@ -262,11 +267,4 @@ def run_unit_test(unit_test: UnitTests):
 
 if __name__ == '__main__':
 
-    unit_test = UnitTests.PLOT_CUM_X
-
-    is_run_all_tests = False
-    if is_run_all_tests:
-        for unit_test in UnitTests:
-            run_unit_test(unit_test=unit_test)
-    else:
-        run_unit_test(unit_test=unit_test)
+    run_local_test(local_test=LocalTests.PLOT_CUM_X)

{stochvolmodels-1.1.1 → stochvolmodels-1.1.2}/stochvolmodels/pricers/gmm_pricer.py

@@ -259,17 +259,22 @@ def gmm_vanilla_chain_pricer(gmm_weights: np.ndarray,
     return model_prices_ttms
 
 
-class UnitTests(Enum):
+class LocalTests(Enum):
     CALIBRATOR = 1
 
 
-def run_unit_test(unit_test: UnitTests):
+def run_local_test(local_test: LocalTests):
+    """Run local tests for development and debugging purposes.
+
+    These are integration tests that download real data and generate reports.
+    Use for quick verification during development.
+    """
 
     import seaborn as sns
     from stochvolmodels.utils import plots as plot
     from stochvolmodels.data.test_option_chain import get_btc_test_chain_data
 
-    if unit_test == UnitTests.CALIBRATOR:
+    if local_test == LocalTests.CALIBRATOR:
         option_chain = get_btc_test_chain_data()
         gmm_pricer = GmmPricer()
         fit_params = gmm_pricer.calibrate_model_params_to_chain(option_chain=option_chain)
@@ -288,11 +293,4 @@ def run_unit_test(unit_test: UnitTests):
 
 if __name__ == '__main__':
 
-    unit_test = UnitTests.CALIBRATOR
-
-    is_run_all_tests = False
-    if is_run_all_tests:
-        for unit_test in UnitTests:
-            run_unit_test(unit_test=unit_test)
-    else:
-        run_unit_test(unit_test=unit_test)
+    run_local_test(local_test=LocalTests.CALIBRATOR)