Mercurial > public > python-black-scholes

annotate README.md @ 13:c3fa0dd36eda

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
let's change the name because is fucking offensive committer: GitHub <noreply@github.com>
author Dennis C. M. <dennis@denniscm.com>
date Wed, 09 Aug 2023 19:42:40 +0100
parents 9995dce9461d
children 06e63d7cdb22
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
c3fa0dd36eda let's change the name because is fucking offensive
Dennis C. M. <dennis@denniscm.com>
parents: 12
diff changeset
1 # python-black-scholes model
4
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
2
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
3 I'm a finance student trying to stop procrastinating and start studying my derivatives lectures. So, in order to
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
4 understand the Black-Scholes model, I built this simple command line tool. Which is far more interesting than memorizing
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
5 stupid stuff from the professor's slides.
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
6
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
7 ## Installation
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
8
11
9ef6b3cc8bdf update readme
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 9
diff changeset
9 ### Using pip
9ef6b3cc8bdf update readme
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 9
diff changeset
10
4
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
11 ```bash
11
9ef6b3cc8bdf update readme
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 9
diff changeset
12 pip3 install fucking-black-scholes
4
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
13 ```
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
14
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
15 ## Usage
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
16
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
17 ```bash
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
18 fbs --help
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
19 ```
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
20
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
21 ### Examples
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
22
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
23 Price a European call option with the following data:
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
24 - Spot price = $20
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
25 - Exercise price = $21
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
26 - Risk free rate = 5%
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
27 - Standard deviation = 25%
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
28 - Time to expiration = 6 months
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
29
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
30 #### Command
11
9ef6b3cc8bdf update readme
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 9
diff changeset
31
4
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
32 ```bash
9
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
33 fbs \
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
34 --spot-price=20.00 \
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
35 --exercise-price=21.00 \
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
36 --risk-free-rate=0.05 \
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
37 --std=0.25 \
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
38 --expiration=0.5
4
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
39 ```
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
40
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
41 #### Output
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
42
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
43 ```bash
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
44 ---------------------------------------------
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
45 European call option price: 1.197698084193286
ccffaf75d240 refactor code
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 0
diff changeset
46 ---------------------------------------------
9
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
47 European put option price: 1.6792062367882679
6f9a6fc6d4d9 add put option calculations
Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
parents: 7
diff changeset
48 ---------------------------------------------
12
9995dce9461d Update README.md
Dennis C. M. <dennis@denniscm.com>
parents: 11
diff changeset
49 ```