69b4d117fa
* Fixes * Update stocks_helper.py * update git-actions set-output to new format * Update stocks_helper.py * Update terminal_helper.py * removed LineAnnotateDrawer from qa_view * lint * few changes * updates * sdk auto gen modules done * Update stocks_helper.py * updates to changed imports, and remove first sdk_modules * Update generate_sdk.py * Update generate_sdk.py * pylint * revert stocks_helper * Update generate_sdk.py * Update sdk.py * Update generate_sdk.py * full auto generation, added sdk.py/controllers creation * missed enable forecasting * added running black in subprocess after sdk files generation completes * removed deleted sdk_arg_logger * comment out tests * property doc fix * clean up * Update generate_sdk.py * make trailmap classes useable for doc generation * Update generate_sdk.py * added lineon to trailmap class for linking to func in markdown * changed lineon to dict * added full_path to trailmap for linking in docs * updated portfolio * added func_def to trailmap attributes for markdown in docs, added missing type hints to covid functions * Update generate_sdk.py * Update generate_sdk.py * Update generate_sdk.py * Update generate_sdk.py * merge * update sdk * updates * Update generate_sdk.py * Update generate_sdk.py * dead imports * bump * updates * updates * updated missing * added alt realestate functions to trailmap, logic to clear folders before building * Update __init__.py * Update generate_sdk.py * clean __init__.py files before build * sync website content folder * Update generate_sdk.py * updates + logging * drop pandas inplace. add docstrings * Update trail_map.py * Update generate_sdk.py * Update trail_map.py * stocks/fa PR added * synced trailmap with develop branch * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update sdk_init.py * fix removed keys functions * updates * reqs txt files * forgot to save * up to date with main * made sure help(openbb.trailmap) is preserved * ruff * Update requirements-full.txt --------- Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com> Co-authored-by: James Maslek <jmaslek11@gmail.com> Co-authored-by: Chavithra <chavithra@gmail.com>
3.7 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Installation | 2 | The OpenBB SDK can be directly installed on your computer via our installation instructions. Within this section, you are guided through the installation process and how to launch the program. If you struggle with the installation process, please don’t hesitate to reach us on Discord or visit our contact page. |
|
Installation
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.
Steps
:::note NOTE Make sure you meet all requirements before proceeding. :::
Follow along with the instructions of the video or use the steps below to use the OpenBB SDK:
1. Install Miniconda
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 the virtual environment
conda create -n obb python=3.9.6 -y
3. Activate the virtual environment
conda activate obb
4. Install OpenBB SDK Core package
pip install openbb
5. (Optional) Install the Toolkits
5.1 If you would like to use the Portfolio Optimization features
:::note NOTE If on Apple Silicon Macs (M1/M2) you will need to install dependency from conda-forge first
conda install -c conda-forge cvxpy=1.2.2 -y
:::
Install the Portfolio Optimization Toolkit
pip install "openbb[optimization]"
5.2 If you would like ML Forecasting features
:::note NOTE If on Apple Silicon Macs (M1/M2) you will need to install the dependency from conda-forge first
conda install -c conda-forge lightgbm=3.3.3 -y
:::
Install the Forecasting Toolkit
pip install "openbb[forecast]"
5.3 If you would like to use both Portfolio Optimization and ML forecast features
:::note NOTE If on Apple Silicon Macs (M1/M2) you will need to install the dependencies from conda-forge first
conda install -c conda-forge lightgbm=3.3.3 cvxpy=1.2.2 -y
:::
Install all Toolkits
pip install "openbb[all]"
Congratulations! You have successfully installed openbb 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. This can be done with the following:
conda activate obb
The OpenBB SDK can be imported to a Jupyter Notebook or any code editor with, from openbb_terminal.sdk import openbb as explained in the How to use the SDK guides. By following the above process, the OpenBB Terminal is automatically included as well which can be ran by typing openbb.