jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 12:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update installation guides with videos (#3903)

Browse Source 
* Fix plot look when using eval and add query to choices (#3881)

* convert index to datetime and update choices

* uncomment economy integration test

* fix treasury concat bug

* fix datasets concat on duplciates

* Update installation guides with videos

* Add fix for Ruff crashing

* Me no longer do what James said

* Lock ruff version so that new lints dont break our CI (#3905)

* Lock ruff version so that new lints dont break our CI

* Bumped pre-commit ruff version

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Jeroen Bouma <jeroenbouma@Jeroens-MacBook-Pro.local>
Co-authored-by: Colin Delahunty <72827203+colin99d@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
This commit is contained in:
Jeroen Bouma
2023-01-12 16:06:03 +01:00
committed by GitHub
parent ac5e1b083c
commit efe46dec8e
4 changed files with 34 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -13,6 +13,10 @@ We provide a simple installation method in order to utilize the OpenBB SDK. You
Make sure you meet all [requirements](requirements.md) before proceeding.
:::
<p>Follow along with the instructions of the video or use the steps below to use the OpenBB SDK:</p>
<iframe width="100%" height="450" src="https://www.youtube.com/embed/gQu6Paz5xN4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
### 1. **Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)**
Download the `x86_64` Miniconda for your respective system and follow along

33
website/content/terminal/quickstart/installation.md vendored
View File

@@ -7,21 +7,25 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import InstallerButton from "@site/src/components/General/InstallerButton";
The OpenBB Terminal can be directly installed on your computer via our installation program. 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](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact).
The OpenBB Terminal can be directly installed on your computer via our installation programs. 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](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact).
OpenBB Terminal is available in all major platforms. With MacOS/Windows you can easily install with the installer (instructions below). It is also available to install on Linux with Docker or from source.
OpenBB Terminal is available on all major platforms. With Windows and macOS you can make use of an installation file as found below. Furthermore, it is also possible to install the OpenBB Terminal with Docker or directly through Python which also offers support for Linux.
:::info Installation Instructions
<Tabs>
<TabItem value="windows" label="Windows">Install on Windows
<TabItem value="windows" label="Windows">
<div class="gdoc-page">
<p>This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows.</p>
</div><p>Download the installer from the button below:</p>
<InstallerButton type="windows" href="https://github.com/OpenBB-finance/OpenBBTerminal/releases/download/v2.1.0/Windows10.OpenBB.Terminal.v2.1.0.exe" label="Windows Installer" />
<p>When the file is downloaded, use the following steps to run the OpenBB Terminal:</p>
<p>Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:</p>
<iframe width="100%" height="450" src="https://www.youtube.com/embed/-Afp6o9YKGE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<div class="gdoc-columns">
<div class="gdoc-columns__content gdoc-markdown--nested">
@@ -48,7 +52,7 @@ OpenBB Terminal is available in all major platforms. With MacOS/Windows you can
</div>
</TabItem>
<TabItem value="mac" label="MacOS">Install on macOS
<TabItem value="mac" label="MacOS">
For Mac there are two installers available, one for Intel and one for Apple Silicon (M1). Please download the correct one for your machine.
@@ -61,7 +65,10 @@ For Mac there are two installers available, one for Intel and one for Apple Sili
</li>
</ul>
<p>When the DMG file is downloaded, use the following steps to run the OpenBB Terminal:</p>
<p>Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:</p>
<iframe width="100%" height="450" src="https://www.youtube.com/embed/lqIuJLuU2e0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<div class="gdoc-columns">
<div class="gdoc-columns__content gdoc-markdown--nested">
@@ -83,11 +90,13 @@ Right-Click the app and select <code>Open</code>. You will see a message saying
</div>
</TabItem>
<TabItem value="docker" label="Docker">
<p>Install with Docker</p>
<p>Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS.
</p>
Here we will detail how to run OpenBB Terminal Docker image.
<p>Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:</p>
<iframe width="100%" height="450" src="https://www.youtube.com/embed/NjXPIfDzQMk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Please check the section matching to your OS.
## 1. Windows
@@ -228,7 +237,11 @@ docker run --rm -it \
</TabItem>
<TabItem value="python" label="Python">
This installation type supports both Windows and Unix systems (Linux + MacOS).
<p>This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS).</p>
<p>Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:</p>
<iframe width="100%" height="450" src="https://www.youtube.com/embed/rDYGmH-bQRk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
**NOTE for Windows users:** For Windows users who prefer to use an environment similar to what Linux and macOS users use, we recommend Windows Subsystem for Linux (WSL). WSL emulates a Linux machine inside your Windows system. If this is the case - jump to the <a href="#installing-wsl-only-for-windows-users">Installing WSL (Only for Windows users)</a> section before proceeding.

4
website/package-lock.json generated vendored
View File

@@ -1,12 +1,12 @@
{
"name": "docs",
"version": "0.0.0",
"version": "1.0.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "docs",
"version": "0.0.0",
"version": "1.0.0",
"dependencies": {
"@cmfcmf/docusaurus-search-local": "^0.11.0",
"@docusaurus/core": "2.2.0",

5
website/yarn.lock vendored
View File

@@ -4299,6 +4299,11 @@
"resolved" "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
"version" "1.0.0"
"fsevents@~2.3.2":
"integrity" "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA=="
"resolved" "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz"
"version" "2.3.2"
"function-bind@^1.1.1":
"integrity" "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A=="
"resolved" "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"