Skip to content

Commit

Permalink
docs - links and order (#3649)
Browse files Browse the repository at this point in the history
* docs - links and order

* few more on sdk side
  • Loading branch information
andrewkenreich authored Nov 29, 2022
1 parent 9e87d6e commit 5b1d7d9
Show file tree
Hide file tree
Showing 17 changed files with 886 additions and 820 deletions.
3 changes: 1 addition & 2 deletions website/content/sdk/guides/intros/econometrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,7 @@ file_load = openbb.econometric.load("PATH_TO_FILE/FILE.xlsx")
### Working with Time Series data

To demonstrate the usage of the Econometrics SDK for time series data, the
<a href="https://www.statsmodels.org/dev/datasets/generated/longley.html" target="_blank" rel="noreferrer noopener">longley</a>
dataset is loaded in.
<a href="https://www.statsmodels.org/dev/datasets/generated/longley.html" target="_blank" rel="noreferrer noopener">longley</a> dataset is loaded in.

```python
# Load the data
Expand Down
2 changes: 1 addition & 1 deletion website/content/sdk/guides/intros/portfolio/po.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ optimization techniques and provides a brief description of its sub-menus"
---
The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.

The capabilities of the [Portfolio Optiminzation menu](/terminal/guides/intros/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.
The capabilities of the [Portfolio Optiminzation menu](/terminal/guides/intros/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer.

## How to use
Start a Python script or Notebook file by importing the module:
Expand Down
2 changes: 1 addition & 1 deletion website/content/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To know more about OpenBB SDK, you can start by reading the [Installation Guide]

### Using OpenBB SDK

To learn how to use OpenBB SDK, you can start by reading the [Structure of the SDK](/sdk/guides/basics/structure) and [Using the SDK](/sdk/guides/basics/using) guides.
To learn how to use OpenBB SDK, you can start by reading the [Basics Guide](/sdk/guides/basics).

### SDK Reference

Expand Down
5 changes: 5 additions & 0 deletions website/content/sdk/quickstart/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Installation
sidebar_position: 2
---

# 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.
Expand Down
4 changes: 2 additions & 2 deletions website/content/terminal/guides/basics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ the commands that you are able to use from any menu in the terminal (see <a href
command. For example, within the `stocks` menu, `about candle` opens <a href="/terminal/reference/stocks/candle/" target="_blank" rel="noreferrer noopener">this guide</a>.
- `wiki`: search for a given expression on the Wikipedia without leaving the terminal.

Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you will see a command named <a href="/terminal/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following:
Continuing with the example mentioned at `quit`, revisit the `stocks` menu and look at the commands. At the top you will see a command named <a href="/terminal/reference/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. To understand what this command can do, you can use `load -h` followed by `ENTER` (⏎). The `-h` stands for `help` and every command will have this feature. This will return the following:

```
2022 May 19, 05:27 (🦋) /stocks/ $ load -h
Expand Down Expand Up @@ -129,7 +129,7 @@ We can check that this period has changed by looking into the <a href="https://w

<a target="_blank" href="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png"><img src="https://user-images.githubusercontent.com/46355364/169503345-a9409637-dc7a-4193-9c87-38b1b6ee1a08.png" alt="Amazon Candle Chart" width="800"/></a>

As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="/terminal/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.
As mentioned in the <a href="#explanation-of-menus">Explanation of Menus</a>, some information also transfers over to other menus and this includes the loaded market data from <a href="/terminal/reference/stocks/load" target="_blank" rel="noreferrer noopener">load</a>. So, if you would visit the `ta` menu (which stands for <a href="https://www.investopedia.com/terms/t/technicalanalysis.asp" target="_blank" rel="noreferrer noopener">Technical Analysis</a>) you will see that, by running any command, the selected period above is depicted again. Return to the Stocks menu again by using `q` and use it again to return to the home screen which can be shown with `?`.


### Defining your own source of data
Expand Down
9 changes: 2 additions & 7 deletions website/content/terminal/guides/intros/common/ba.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Some data sources will require a valid API key, which can be obtained for free a
- <a href="https://sentimentinvestor.com/" target="_blank" rel="noreferrer noopener">Sentiment
Investor</a><br/>

See the <a href="/terminal/guides/advanced/keys" target="_blank" rel="noreferrer noopener">Set API keys</a> for help with API keys in the Terminal.
See the <a href="/terminal/guides/advanced/api-keys" target="_blank" rel="noreferrer noopener">Set API keys</a> for help with API keys in the Terminal.

### Examples

Expand Down Expand Up @@ -169,7 +169,7 @@ The <a href="/terminal/reference/stocks/ba/sentiment/" target="_blank" rel="nore

<img alt="sentiment" src="https://user-images.githubusercontent.com/46355364/170243539-1ea3fc6a-d7ec-4991-a6bb-ed5879753328.png"></img>

More advanced techniques can also be applied by using tools from <a href="https://sentimentinvestor.com" target="_blank" rel="noreferrer noopener">Sentiment Investor</a> that analyzes millions of messages to show the most talked about stocks by hour. This has the ability to show the most trending tickers with <a href="/terminal/reference/stocks/ba/trending/" target="_blank" rel="noreferrer noopener">trending</a> and historical sentiment data with <a href="/terminal/reference/stocks/ba/hist/" target="_blank" rel="noreferrer noopener">hist</a>.
More advanced techniques can also be applied by using tools from <a href="https://sentimentinvestor.com" target="_blank" rel="noreferrer noopener">Sentiment Investor</a> that analyzes millions of messages to show the most talked about stocks by hour. This has the ability to show the most trending tickers with <a href="/terminal/reference/stocks/ba/trending/" target="_blank" rel="noreferrer noopener">trending</a>.

```
(🦋) /stocks/ba/ $ trending
Expand All @@ -188,13 +188,8 @@ Most trending stocks at 2022-05-23 00:00
| NVAX | 13.00 | 4.00 | 0.47 | 0.40 |
| NVDA | 12.00 | 11.00 | 0.45 | 0.47 |
| DIS | 12.00 | 1.00 | 0.69 | 0.44 |
(🦋) /stocks/ba/ $ hist -s 2022-05-01
```

<a target="_blank" href="https://user-images.githubusercontent.com/46355364/170243719-fccf414b-3a89-4776-88de-e30f4eb34f89.png"><img alt="hist" src="https://user-images.githubusercontent.com/46355364/170243719-fccf414b-3a89-4776-88de-e30f4eb34f89.png"></img></a>

Inspired by the Twitter user, <a href="https://twitter.com/CramerTracker" target="_blank" rel="noreferrer noopener">@cramertracker</a>, the final two features follow (CNBC Talking Head) Jim Cramer stock recommendations as satire that rings true.

```
Expand Down
2 changes: 1 addition & 1 deletion website/content/terminal/guides/intros/crypto/dd.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ with a brief overview of the features."
geekdocCollapseSection: true
---

The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper into the coin of choice. To be able to do this, the menu offers basic information about the loaded coin (<a href="/terminal/reference/crypto/dd/info" target="_blank" rel="noreferrer noopener">info</a> and <a href="/terminal/reference/crypto/dd/basic" target="_blank" rel="noreferrer noopener">basic</a>), information about the project, technology details, audits etcetera (<a href="/terminal/reference/crypto/dd/pi" target="_blank" rel="noreferrer noopener">pi</a>), insights into the coin balance and order book (<a href="/terminal/reference/crypto/dd/balance" target="_blank" rel="noreferrer noopener">balance</a> and <a href="/terminal/reference/crypto/dd/cbbook" target="_blank" rel="noreferrer noopener">cbbook</a>), the tokenomics and fundraising details
The Cryptocurrency Due Diligence menu gives the user the ability to delve deeper into the coin of choice. To be able to do this, the menu offers basic information about the loaded coin (<a href="/terminal/reference/crypto/dd/info" target="_blank" rel="noreferrer noopener">info</a> and <a href="/terminal/reference/crypto/dd/basic" target="_blank" rel="noreferrer noopener">basic</a>), information about the project, technology details, audits etcetera (<a href="/terminal/reference/crypto/dd/pi" target="_blank" rel="noreferrer noopener">pi</a>), insights into the coin balance (<a href="/terminal/reference/crypto/dd/balance" target="_blank" rel="noreferrer noopener">balance</a>), the tokenomics and fundraising details
(<a href="/terminal/reference/crypto/dd/tk" target="_blank" rel="noreferrer noopener">tk</a> and <a href="/terminal/reference/crypto/dd/fr" target="_blank" rel="noreferrer noopener">fr</a>) and lastly, social media activity (<a href="/terminal/reference/crypto/dd/mt" target="_blank" rel="noreferrer noopener">mt</a>, <a href="/terminal/reference/crypto/dd/twitter" target="_blank" rel="noreferrer noopener">twitter</a> and <a href="/terminal/reference/crypto/dd/dev" target="_blank" rel="noreferrer noopener">dev</a>).

### How to use
Expand Down
3 changes: 1 addition & 2 deletions website/content/terminal/guides/intros/crypto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ excerpt: "The Introduction to Cryptocurrency explains how to use the Cryptocurre

The Cryptocurrency menu allows you to discover trending cryptocurrency (<a href="/terminal/guides/intros/crypto/disc/" target="_blank" rel="noreferrer noopener">disc</a>). Additionally, you can also perform research of a specific coin (<a href="/terminal/guides/intros/crypto/dd" target="_blank" rel="noreferrer noopener">dd</a>),
NFT (<a href="/terminal/guides/intros/crypto/nft" target="_blank" rel="noreferrer noopener">nft</a>) or most lucrative Defi project
(<a href="/terminal//guides/intros/crypto/defi" target="_blank" rel="noreferrer noopener">defi</a>). It does so by handing you tools to (among other things) perform technical analysis (<a href="/terminal/guides/intros/common/ta/" target="_blank" rel="noreferrer noopener">ta</a>), quantitative analysis (<a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">qa</a>), and give you access to onchain information (<a href="/terminal/guides/intros/crypto/onchain/" target="_blank" rel="noreferrer noopener">onchain</a>).
(<a href="/terminal/guides/intros/crypto/defi" target="_blank" rel="noreferrer noopener">defi</a>). It does so by handing you tools to (among other things) perform technical analysis (<a href="/terminal/guides/intros/common/ta/" target="_blank" rel="noreferrer noopener">ta</a>), quantitative analysis (<a href="/terminal/guides/intros/common/qa" target="_blank" rel="noreferrer noopener">qa</a>), and give you access to onchain information (<a href="/terminal/guides/intros/crypto/onchain/" target="_blank" rel="noreferrer noopener">onchain</a>).

### How to use

Expand Down Expand Up @@ -46,7 +46,6 @@ The Cryptocurrency menu has an extensive list of available sub-menus ranging fro
- [Introduction to Cryptocurrency Overview](/terminal/guides/intros/crypto/ov/): gives the overview of the cryptocurrency market, including global Defi market, stablecoins, exchanges as well as latest news.
- [Introduction to Cryptocurrency Onchain](/terminal/guides/intros/crypto/onchain/): provides information on different blockchains, whales transaction and traded volumes on certain crypto pair. You can also specify a Ethereum address and look up past transactions and balance history.
- [Introduction to Cryptocurrency Decentralized Finance (DeFi)](/terminal/guides/intros/crypto/defi/): explore the decentralized finance market through a variety of indicators and data, from lending interests, staking ratio, Uniswap pools to top Defi dApps.
- [Introduction to Cryptocurrency Tools](/terminal/guides/intros/crypto/tools/): gives you the tool to calculate crypto metrics, such as impermanent loss and converting APR to APY.
- [Introduction to Non Fungible Tokens (NFTs)](/terminal/guides/intros/crypto/nft/): Discover latest NFT drops and OpenSea's NFT Collection statistics.
- [Introduction to Cryptocurrency Due Diligence](/terminal/guides/intros/crypto/dd/): performs due diligence on a chosen coin based on, among other things, tokenomics, roadmaps, news, and community.
- [Introduction to Technical Analysis](/terminal/guides/intros/common/ta/): analyzes the chosen coin's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
Expand Down
4 changes: 2 additions & 2 deletions website/content/terminal/guides/intros/etf.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ menu and provides a brief description of its sub-menus"

---

The ETF menu enables you to lookup any ETFand obtain an <a href="/terminal/reference/etf/overview" target="_blank" rel="noreferrer noopener">overview</a>, <a href="/terminal/reference/etf/holdings" target="_blank" rel="noreferrer noopener">holdings</a>, <a href="/terminal/reference/etf/weights" target="_blank" rel="noreferrer noopener">weights</a> and <a href="/terminal/reference/etf/news" target="_blank" rel="noreferrer noopener">news</a> about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to <a href="/terminal/guides/intros/stocks/ca" target="_blank" rel="noreferrer noopener">compare companies</a> within the ETF, discover gainers and losers within <a href="/terminal/reference/etf/disc" target="_blank" rel="noreferrer noopener">discovery</a> and apply advanced <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">technical indicators</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a>. Lastly, it also has the option to export multiple ETFs to Excel with <a href="/terminal/reference/etf/pir" target="_blank" rel="noreferrer noopener">pir</a>.
The ETF menu enables you to lookup any ETFand obtain an <a href="/terminal/reference/etf/overview" target="_blank" rel="noreferrer noopener">overview</a>, <a href="/terminal/reference/etf/holdings" target="_blank" rel="noreferrer noopener">holdings</a>, <a href="/terminal/reference/etf/weights" target="_blank" rel="noreferrer noopener">weights</a> and <a href="/terminal/reference/etf/news" target="_blank" rel="noreferrer noopener">news</a> about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to <a href="/terminal/guides/intros/stocks/comparison" target="_blank" rel="noreferrer noopener">compare companies</a> within the ETF, discover gainers and losers within <a href="/terminal/reference#disc" target="_blank" rel="noreferrer noopener">discovery</a> and apply advanced <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">technical indicators</a> and <a href="/terminal/guides/intros/forecast" target="_blank" rel="noreferrer noopener">Forecasting menu</a>. Lastly, it also has the option to export multiple ETFs to Excel with <a href="/terminal/reference/etf/pir" target="_blank" rel="noreferrer noopener">pir</a>.

### How to use

Expand Down Expand Up @@ -77,7 +77,7 @@ Which shows the following graph:

The ETF menu has a few sub-menus available to delve further into a specific ETF or screen multiple ETFs at the same time. To find more information about each menu, click on one of the following:

- <a href="/terminal/guides/intros/stocks/ca/" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance.
- <a href="/terminal/guides/intros/stocks/comparison" target="_blank" rel="noreferrer noopener">Introduction to Comparison Analysis</a>: have the ability to compare companies within the ETF based on, among other things, correlation, financial statements, sentiment, valuations and performance.
- <a href="/terminal/guides/intros/common/ta" target="_blank" rel="noreferrer noopener">Introduction to Technical Analysis</a>: analysis the chosen ETF's historical data extensively with moving averages and momentum, trend, volatility and volume indicators.
- <a href="/terminal/guides/intros/forecast/" target="_blank" rel="noreferrer noopener">Introduction to Forecasting menu</a>: apply advanced AI and Machine Learning models to form prediction of future ETF prices including Recurrent Neural Network (RNN), Autoregressive Integrated Moving Average (ARIMA) and Monte Carlo forecasting.

Expand Down
Loading

0 comments on commit 5b1d7d9

Please sign in to comment.