Creates examples folder for SDK Notebook examples (#5057)

* Creates examples folder for SDK Notebook examples 

This commit creates a folder and readme file for SDK examples as Jupyter Notebooks.

* Four notebook files added.

This commit adds four notebook examples.

* historical prices draft 2

* removes spaces from file name.

* fix one mistake

* rename file

* renames file

* updates realized vol notebook

* Renaming file.

* Delete old file name.

* updates usdLiquidtyIndex

* update copperToGoldRatio

* updates README.md

* spelling

* updates copperToGold load data cell

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
This commit is contained in:
Danglewood
2023-05-27 13:06:09 -07:00
committed by GitHub
parent fcb78d71f2
commit 7c193656a1
5 changed files with 207752 additions and 0 deletions

50
examples/README.md vendored Normal file
View File

@@ -0,0 +1,50 @@
# Jupyter Notebook Examples Using the OpenBB SDK
This folder is a collection of example notebooks that demonstrate some of the ways to get started using the OpenBB SDK. To run them, ensure that the active kernel selected is the same Python virtual environment where OpenBB was installed.
## Table of Contents
### loadHistoricalPriceData
This notebook walks through collecting historical price data using a variety of methods and sources.
- Loading data with different intervals, and changing sources.
- A brief explanation of ticker symbology.
- Using other functions and modules to load data with besides `openbb.stocks.load()`.
- Gang-loading a list of tickers' price data in a single call.
- Drawing candle and line charts.
### copperToGoldRatio
This notebook explains how to calculate and plot the Copper-to-Gold ratio.
- Loading historical front-month futures prices.
- Getting the historical series from FRED for the 10-year constant maturity US treasury bill.
- Performing basic DataFrame operations.
- Creating OpenBB Figure objects, and plotting on two y-axis.
### realizedVolatilityModels
This notebook demonstrates the six, realized volatility models with in the Technical Analysis module.
- Explore differences between:
- Standard Deviation
- Parkinson
- Hodges-Tompkins
- Garman-Klass
- Rogers-Satchell
- Yang-Zhang
- Creating and plotting realized volatility cones.
- Overlaying multiple time series.
- Use the calculated outputs as inputs to a forecast model.
### usdLiquidityIndex
This notebook demonstrates how to query the Federal Reserve Economic Database and recreate the USD Liquidity Index.
- Search FRED for series IDs.
- Load multiple series as a single call.
- Unpacking the data response from the FRED query.
- Perform arithmetic operations on a DataFrame.
- Normalization methods for a series or DataFrame.
- Simple processes for creating charts.

95896
examples/copperToGoldRatio.ipynb vendored Normal file

File diff suppressed because it is too large Load Diff

28256
examples/loadHistoricalPriceData.ipynb vendored Normal file

File diff suppressed because it is too large Load Diff

73355
examples/realizedVolatilityModels.ipynb vendored Normal file

File diff suppressed because it is too large Load Diff

10195
examples/usdLiquidityIndex.ipynb vendored Normal file

File diff suppressed because it is too large Load Diff