Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

making install instructions more clear #3736

Merged
merged 5 commits into from
Dec 13, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions website/content/sdk/quickstart/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -37,41 +41,45 @@ 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]"
```

#### 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]"
```

#### 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]"
Expand Down