Metadata-Version: 2.1
Name: optionsPricingAndGreeks
Version: 0.0.2
Summary: A package to calculate the price of options and the greeks
Project-URL: Homepage, https://github.com/FilippoTomelleri/optionsPricing-Greeks
Author-email: Filippo Tomelleri <filippo.tomelleri01@gmail.com>
License-File: LICENSE
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# Option pricing methods

This package aims to provide 4 different methods to estimate the price of options.

The estimator don't allow to set all the parameters but just accept a stock, in the constructor, and then evaluate the price of an option of that stock.
This lead to be able to estimate real world data, but doesn't allow to create custom environment with fake option price, volatility etc. etc.

Instead the estimators takes the last prices (for the period of this prices go to the "setting parameter" section) of the stock and calculate volatility and the drift of the stock.

The 4 model to estimate a the price of an option are the most popular one:
- binomial model
- monte carlo simulation
- black-scholes formula
- bootstrap

## Setting paramter
The only (financial) paramter that should be set is the annual risk free rate. As a default it is set to 0.04 in the super class of the estimator, so it's not a compulsary argument in the
estimate methods.

Another parameter that can be set is the period that the estimators take into consideration to calculate the volatility and drift of the stock. Also this parameter is set
in the superclass of the estimators and its default value is six months. If we want to change it we should set the estimate method parameter periodForPrices to a value of the period
enumeration that is defined in the utilities directory.

### Monte carlo estimator
For the monte carlo estimator there are another couple of customizable parameter in the estimate method:

- <ins>numberOfSimulations</ins>: the number of simulations of the asset price path that are run to evaluate the option price
- <ins>showSimulationPaths</ins>: plot a chart with the paths of the stock price for each simulation

## American option
For american options has been implemented a method in the binomial estimator (*estimateAmericanOption*). In all the other methods we suppose to work with european options