Skip to content

Commit

Permalink
add changes to docs (#3533)
Browse files Browse the repository at this point in the history
* add changes

* fix

* change 2

* fix: new folder structure

* fix: jeroen stuff

* fix: grammer

Co-authored-by: jose-donato <[email protected]>
Co-authored-by: jose-donato <[email protected]>
Co-authored-by: James Maslek <[email protected]>
  • Loading branch information
4 people authored Nov 22, 2022
1 parent bfc4c02 commit a0c5b49
Show file tree
Hide file tree
Showing 69 changed files with 5,531 additions and 4,543 deletions.
4 changes: 0 additions & 4 deletions website/content/sdk/guides/guides/_category_.json

This file was deleted.

4 changes: 4 additions & 0 deletions website/content/sdk/guides/intros/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Intros",
"position": 2
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
86 changes: 67 additions & 19 deletions website/content/sdk/quickstart/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,83 @@ title: Installation
sidebar_position: 2
---

### Steps
We provide a simple installation method in order to utilize the OpenBB SDK. You must first create an environment,
which allows you to isolate the SDK from the rest of your system. It is our recommendation that you utilize a
`conda` environment because there are optional features, such as `forecast`, that utilize libraries that are
specifically sourced from `conda-forge`. Due to this, if you do not use a conda environment, you will not be
able to use some of these features. As such, the installation steps will be written under the assumption that
you are using conda.

1. **Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)**
## Steps

### 1. **Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)**

Download the `x86_64` Miniconda for your respective system and follow along
with it's installation instructions. The Miniconda architecture MUST be
`x86_64` in order to use certain features.

2. **Create Environment**
### 2. **Create the virtual environment**

```bash
conda create -n obb python=3.9.6 -y
```

### 3. **Activate the virtual environment**

```bash
conda activate obb
```

### 4. **Install OpenBB SDK Core package**

```bash
pip install openbbterminal
```

### 5. **(Optional) Install the Toolkits**

#### 5.1 **If you would like to use the Portfolio Optimization features**

On Apple Silicon Macs (M1/M2) install dependency from conda-forge

```bash
conda install -c conda-forge cvxpy=1.2.2 -y
```

And install the Portfolio Optimization Toolkit

```bash
pip install "openbbterminal[optimization]"
```

#### 5.2 **If you would like ML Forecasting features**

On Apple Silicon Macs (M1/M2) install dependency from conda-forge

```bash
conda install -c conda-forge lightgbm=3.3.3 -y
```

And install the Forecasting Toolkit

```bash
pip install "openbbterminal[prediction]"
```

```shell
conda create -n <environment> python=3.9.6 -y
```
#### 5.3 **If you would like to use both Portfolio Optimization and ML forecast features**

:::note (Optional) If you would like machine learning forecast features:
On Apple Silicon Macs (M1/M2) install dependencies from conda-forge

```shell
conda install -c conda-forge u8darts-torch=0.22.0 -y
conda install -c conda-forge pytorch-lightning=1.6.5 -y
```
```bash
conda install -c conda-forge lightgbm=3.3.3 cvxpy=1.2.2 -y
```

3. **Install OpenBB Terminal**
And install the Both Toolkits

```shell
pip install openbbterminal
```
```bash
pip install "openbbterminal[all]"
```

:::note (Optional) If you would like machine learning forecast features:
Congratulations! You have successfully installed `openbbterminal` on an environment and are now able to begin using it. However, it is important to note that if you close out of your CLI you must re-activate your environment in order begin using it again.

```shell
pip install "openbbterminal[prediction]"
```
The Terminal can now be launched by entering, `openbb`, and the SDK can be imported to a Jupyter Notebook file or code editor with, `from openbb_terminal.sdk import openbb`
53 changes: 9 additions & 44 deletions website/content/sdk/quickstart/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,16 @@ import TabItem from '@theme/TabItem';

The OpenBB SDK is a set of tools for financial and data analysis. We recommend starting out with some experience in finance, markets, and Python. The purpose of this page is to outline some of the background information required to get the most out of the software.

### Recommended System Requirements

- 16GB RAM or more
- Dedicated graphics card
- 5GB free storage
- A code editor, such as VS Code, with some extensions:

- Jupyter
- Jupyter Power Toys
- Python Environment Manager
- Python Extension Pack
- mplstyle

- Chrome or Firefox
- Open Office

### Minimum System Requirements

- 8GB RAM or more
- 4GB RAM or more
- 5GB free storage
- A code editor, such as VS Code
- Chrome or Firefox
- A code editor or Jupyter Notebook
- Internet connection

:::note NOTES ON THE INTERNET CONNECTIVITY
Installation of the SDK with all the toolkits would require downloading around 4GB of data. Querying data does not require a lot of bandwidth but you will certainly have a more pleasant experience if you will be on a fast internet line. 4G networks provide a good enough experience so if you're traveling your personal hot-spot will do. While it's technically possible to use a subset of the functionality in off-line mode, you will not be able to use any data that is queried from the APIs of data providers and services.
:::info

:::info OS Specific Requirements

Expand All @@ -38,6 +26,7 @@ The OpenBB SDK is a set of tools for financial and data analysis. We recommend s
<div class="gdoc-page">

</div><p>The OpenBB platform requires MacOS Catalina or higher. The oldest Mac configuration known to work is a MacPro 3,1 (OS Catalina) and functions relying on the Intel Math Kernel (Forecast models like RNN) are not compatible with the CPU.</p>
<p>Portfolio Optimization Toolkit and Forecasting Toolkit on Apple Silicon: To install the Forecasting toolkit on M1/M2 macs you need to use the x86_64 version of conda and install certain dependencies from conda-forge. Further Instructions can be found in the Installation section</p>
<div class="gdoc-columns">

</div>
Expand All @@ -46,9 +35,7 @@ The OpenBB SDK is a set of tools for financial and data analysis. We recommend s
<TabItem value="Windows" label="Windows">
<div class="gdoc-page">

</div><p>Windows 10 or higher is required, and the user account should be have administrator privileges.

Additionally, its recommended Windows users also install [Git for Windows](https://git-scm.com/download/win) and use `Git Bash` as the terminal application instead of CMD or PowerShell.
</div><p>Windows 10 or higher is required.

</p>
<div class="gdoc-columns">
Expand Down Expand Up @@ -132,25 +119,3 @@ openbb.economy.ycrv_chart()
```

![Screenshot 2022-11-21 at 4 29 17 PM](https://user-images.githubusercontent.com/85772166/203185342-f019414d-24e2-4d8a-a718-10eeedb59e8c.png)

Users should have some experience working with Python and be comfortable working from the command line. There are many online resources dedicated to learning the Python language, such as:

- [Python.org](https://www.python.org/about/gettingstarted/)
- [W3 Schools](https://www.w3schools.com/python/)
- [Python Wiki](https://wiki.python.org/moin/BeginnersGuide)

## Resources for Finance

Below is a collection of useful websites:

- [Investopedia](https://www.investopedia.com/)
- [The Federal Reserve Economic Database](https://fred.stlouisfed.org/)
- [Options Industry Council](https://www.optionseducation.org/)
- [DTCC Learning](https://dtcclearning.com/)
- [Nasdaqtrader](https://nasdaqtrader.com/Trader.aspx?id=symbollookup)
- [EDGAR Full Text Search](https://www.sec.gov/edgar/search/#)
- [EDGAR Historical Documents](https://www.sec.gov/cgi-bin/srch-edgar)
- [US Government Open Data](https://data.gov/)
- [ECB Statistical Warehouse](https://sdw.ecb.europa.eu/)
- [AlphaVantage Academy](https://www.alphavantage.co/academy/)
- [FINRA](https://otce.finra.org/otce/home)
Loading

0 comments on commit a0c5b49

Please sign in to comment.