jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 05:21:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

making install instructions more clear (#3736)

Browse Source 
* making install instructions more clear

* install instruction - requirements link

Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com>
This commit is contained in:
andrewkenreich
2022-12-12 19:17:46 -05:00
committed by GitHub
parent e38fec5a5c
commit 3ddb092f9c
1 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
website/content/sdk/quickstart/installation.md vendored
View File

@@ -9,6 +9,10 @@ We provide a simple installation method in order to utilize the OpenBB SDK. You
## Steps
:::note NOTE
Make sure you meet all [requirements](requirements.md) before proceeding.
:::
### 1. **Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)**
Download the `x86_64` Miniconda for your respective system and follow along
@@ -37,13 +41,15 @@ pip install openbb
#### 5.1 **If you would like to use the Portfolio Optimization features**
On Apple Silicon Macs (M1/M2) install dependency from conda-forge
:::note NOTE
If on Apple Silicon Macs (M1/M2) you will need to install dependency from conda-forge first
```bash
conda install -c conda-forge cvxpy=1.2.2 -y
```
:::
And install the Portfolio Optimization Toolkit
Install the Portfolio Optimization Toolkit
```bash
pip install "openbb[optimization]"
@@ -51,13 +57,14 @@ pip install "openbb[optimization]"
#### 5.2 **If you would like ML Forecasting features**
On Apple Silicon Macs (M1/M2) install dependency from conda-forge
:::note NOTE
If on Apple Silicon Macs (M1/M2) you will need to install the dependency from conda-forge first
```bash
conda install -c conda-forge lightgbm=3.3.3 -y
```
:::
And install the Forecasting Toolkit
Install the Forecasting Toolkit
```bash
pip install "openbb[prediction]"
@@ -65,13 +72,14 @@ pip install "openbb[prediction]"
#### 5.3 **If you would like to use both Portfolio Optimization and ML forecast features**
On Apple Silicon Macs (M1/M2) install dependencies from conda-forge
:::note NOTE
If on Apple Silicon Macs (M1/M2) you will need to install the dependencies from conda-forge first
```bash
conda install -c conda-forge lightgbm=3.3.3 cvxpy=1.2.2 -y
```
:::
And install the Both Toolkits
Install all Toolkits
```bash
pip install "openbb[all]"