From db25cc554c48fd7c8ec5121bc6804a2397d78957 Mon Sep 17 00:00:00 2001
From: Danglewood <85772166+deeleeramone@users.noreply.github.com>
Date: Fri, 24 Feb 2023 11:07:03 -0800
Subject: [PATCH] rename sdk faq to troubleshooting
---
website/content/sdk/quickstart/faq.md | 166 -------
.../content/sdk/quickstart/installation.md | 2 +-
.../content/sdk/quickstart/troubleshooting.md | 412 ++++++++++++++++++
3 files changed, 413 insertions(+), 167 deletions(-)
delete mode 100644 website/content/sdk/quickstart/faq.md
create mode 100644 website/content/sdk/quickstart/troubleshooting.md
diff --git a/website/content/sdk/quickstart/faq.md b/website/content/sdk/quickstart/faq.md
deleted file mode 100644
index fa1b184db0d..00000000000
--- a/website/content/sdk/quickstart/faq.md
+++ /dev/null
@@ -1,166 +0,0 @@
----
-title: FAQ
-sidebar_position: 3
-keywords: [faq, frequently asked questions, openbb sdk]
----
-
-## General
-
-How do I update the OpenBB SDK?
-
-
-With new releases of the OpenBB SDK, it would suffice to use `pip install openbb`. If this doesn't update to the latest version you can include the version number as follows `pip install openbb==2.0.0`. Please find the latest version [here](https://pypi.org/project/openbb/).
-
-
-Where does the data from the OpenBB SDK come from?
-
-
-The OpenBB platform does not provide any data itself as the platform is a data aggregator that connects to almost a hundred different data providers and APIs to access the data.
-
-
-What programs need to be allowed for Windows Firewall?
-
-
-When issues arise regarding Windows Firewall, please allow the following applications through (if not already):
-
-- BranchCache
-- Hyper-V
-- VcXsrv
-- Windows Terminal
-
-From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow.
-
-
-On what Operating Systems can I run OpenBB SDK?
-
-
-The OpenBB Terminal is compatible with Windows, Mac Os and Linux. Check the
-[installation guide](/sdk/quickstart/installation) and [requirements outline](/sdk/quickstart/requirements) for more details.
-
-
-How much hard drive space is required?
-
-
-An installation will use approximately 4GB of space.
-
-
-How do I launch Jupyter Lab or Jupyter Notebook for use with the OpenBB SDK?
-
-
-Once the installation is finished via `pip` and you have activated the conda environment, as explained in the [installation guide](/sdk/quickstart/installation) you are able to activate a Jupyter Notebook by running `jupyter notebook` or Jupyter Lab with `jupyter lab`. Then, you should be able to use the OpenBB SDK by following along with the [How to use the SDK](/sdk/guides/basics#how-to-use-the-sdk) guide.
-
-
-How can I contribute to the OpenBB SDK
-
-
-There are three main ways of contributing to this project.
-
-**BECOME A CONTRIBUTOR**
-
-1. Fork the [Project](https://github.com/OpenBB-finance/OpenBBTerminal)
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Install the pre-commit hooks by running: `pre-commit install`
- Any time you commit a change, linters will be run automatically. On changes, you will have to re-commit
-4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-5. Push to your Branch (`git push origin feature/AmazingFeature`)
-6. Open a Pull Request
-
-You can read more details about adding a feature in our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
-
-**RAISE AN ISSUE OR REQUEST A FEATURE**
-
-- Raise an issue by opening a [bug ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues).
-- Request a new feature through a [feature request ticket](https://github.com/OpenBB-finance/OpenBBTerminal/issues).
-
-
-How do I report a bug?
-
-
-First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D)
-
-
-How can I get help with OpenBB SDK?
-
-
-You can get help with OpenBB SDK by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support).
-
-
-How can I give feedback about the OpenBB SDK?
-
-
-Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model.
-
-You can contact us via the following routes:
-
-- If you notice that a feature is missing inside the terminal, please fill in the Request a Feature form.
-- If you wish to report a bug, have a question/suggestion or anything else, please fill in the Support form.
-- If you wish to speak to us directly, please contact us via Discord.
-
-
-What kind of architectural pattern does the OpenBB SDK use?
-
-
-Throughout the entire OpenBB Platform, the [Model-view-controller](https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller) architectural pattern is used for creating functionality in the terminal.
-
-This is visible in the OpenBB SDK with the addition of `_chart` within functions relating to the `view` portfion of the pattern.
-
-For example the model is displayed with:
-
-```
-openbb.economy.ycrv()
-```
-
-| | Maturity | Rate |
-| --: | --------: | ---: |
-| 0 | 0.0833333 | 3.93 |
-| 1 | 0.25 | 4.34 |
-| 2 | 0.5 | 4.61 |
-| ... | ... | ... |
-| 8 | 10 | 3.82 |
-| 9 | 20 | 4.13 |
-| 10 | 30 | 3.92 |
-
-And the view with:
-
-```
-openbb.economy.ycrv_chart()
-```
-
-
-
-
-Why is data from today missing when I use the load function?
-
-
-By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present.
-
-
-Do I have to use Miniconda?
+
+There are certain dependencies which are sourced exclusively from the `conda-forge` directory. Other virtual environment managers, such a `venv`, may not solve the environment properly, resulting in failed package installations or incorrect builds. We highly recommend using Miniconda as the Python virtual environment manager for installing the OpenBB SDK.
+
+How do I update my installation to the latest version?
+
+The code is constantly being updated with new features and bug fixes. The process for updating will vary by the installation type:
+
+- For a `pip` installation, when a new version is published: `pip install -U openbb[all]`
+- Upgrade a cloned version of the GitHub repo with:
+
+```console
+git fetch
+git pull
+poetry install -E all
+```
+
+**Notes:** If the cloned repository is a fork, pull from: `git pull origin main`, or, `git pull origin develop`. If there are changes locally to the files that conflict with the incoming changes from GitHub, stash them before pulling from main with `git stash`.
+
+"Microsoft Visual C++ 14.0 or greater is required"
+
+Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again.
+
+Error: failed building wheel for bt
+
+There may be an additional message that is printed from this error, stating: "Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools".
+
+Download and install it. [https://visualstudio.microsoft.com/visual-cpp-build-tools/](https://visualstudio.microsoft.com/visual-cpp-build-tools/)
+
+Mac and Linux users may also encounter a similar error because a C++ compiler is not installed. Install Homebrew:
+
+```console
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+```
+
+Then run:
+
+```console
+brew install gcc
+brew install cmake
+```
+
+Additionally, Mac users should install Rosetta:
+
+```console
+softwareupdate --install-rosetta
+```
+
+Miniconda3 will not install on ARM/Linux Raspberry Pi machines.
+
+Refer to this issue on the Conda [GitHub](https://github.com/conda/conda/issues/10723) page.
+
+ModuleNotFoundError: No module named '______'
+
+Before troubleshooting please verify that the recommended installation instructions were followed. These errors often can occur when the virtual environment has not been activated, or the `poetry install` command was skipped. Activate the OpenBB virtual environment created during the installation process prior to launching or importing the SDK.
+
+**Terminal**:
+
+```console
+conda activate obb
+python terminal.py
+```
+
+**SDK**:
+
+```console
+conda activate obb
+ipython
+from openbb_terminal.sdk import openbb
+```
+
+**Jupyter**:
+
+Check that the kernel selected for the session is the OpenBB virtual environment created during the installation process and then re-run the cell.
+
+```console
+from openbb_terminal.sdk import openbb
+```
+
+There is also a possibility that a new dependency has been added to the code and it has not yet been installed in the environment. This may happen after updating the code from GitHub, but before running the `poetry install` install command.
+
+```console
+poetry install -E all
+```
+
+SSL certificates fail to authorize
+
+```console
+SSL: CERTIFICATE_VERIFY_FAILED
+```
+
+An error message, similar to above, is usually encountered while attempting to use the OpenBB Platform from behind a firewall. A workplace environment is typically the most common occurrence. Try connecting to the internet directly through a home network to test the connection. If using a work computer and/or network, we recommend speaking with the company's IT department prior to installing or running any software.
+
+A potential solution is to try:
+
+```console
+pip install pip-system-certs
+```
+
+Cannot connect due to proxy connection.
+
+Find the `.env` file (located at the root of the user account folder: (`~/.openbb_terminal/.env`), and add a line at the bottom of the file with:
+
+```console
+HTTP_PROXY="" or HTTPS_PROXY="”
+```
+
+## General Operation
+
+What is the correct format for entering dates to function variables?
+
+Dates should be entered as a string variable, inside of quotation marks, formatted as `%Y-%m-%d` - YYYY-MM-DD.
+
+Does the portfolio menu allow for dividends, interest, or other distributions?
+
+Currently, this is only possible by manually updating the portfolio file.
+
+Why does my Portfolio file fail to load?
+
+This can be the result of a formatting error, check the file in a simple text editor to observe any abnormalities in the formatting; or, it could be a bug - check the [GitHub issues page](https://github.com/OpenBB-finance/OpenBBTerminal/issues) for similar errors.
+
+- Check that all the necessary column titles are present.
+- Inspect the file to see if cells left blank have been filled unintentionally with 0 or NaN values.
+- A particular asset may not be able to load data. Check for valid historical data from the Stocks menu.
+- Format ticker symbols according to yFinance naming convention.
+- All dates must be entered as YYYY-MM-DD.
+- Transactions dated for today will fail to load historical data.
+- MacOS users should attempt to avoid using the Numbers application as it has a habit of changing the formatting while saving.
+
+Files can be formatted as either `.csv` or `.xlsx` files, and the required column headers are:
+
+`[Date,Type,Ticker,Side,Price,Quantity,Fees,Investment,Currency,Sector,Industry,Country,Region]`
+
+See the guide [here](https://docs.openbb.co/sdk/guides/intros/portfolio) for more information.
+
+How do I change the chart styles?
+
+Place style sheets in this folder: `OpenBBUserData/styles/user`
+
+To select the light themes:
+
+```python
+from openbb_terminal.sdk import TerminalStyle
+theme = TerminalStyle("light", "light", "light")
+```
+
+To select the dark themes:
+
+```python
+from openbb_terminal.sdk import TerminalStyle
+theme = TerminalStyle("dark", "dark", "dark")
+```
+
+
Where are the included stock screener presets located?
+
+The files are located in the folder with the code, under:
+
+`~/openbb_terminal/miscellaneous/stocks/screener`
+
+Alternatively, the source code on GitHub is [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/stocks/screener)
+
+Data from today is missing.
+
+By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present.
+
+```console
+df = openbb.stocks.load(SPY, interval = 60)
+```
+
+Can I stream live prices and news feeds?
+
+It is not currently possible to stream live feeds with the OpenBB SDK.
+
+"Pair BTC/USDT not found in binance"
+
+US-based users are currently unable to access the Binance API. Please try loading the pair from a different source, for example:
+
+`load btc --source CCXT --exchange kraken`
+
+Why does a specific menu or command not exist?
+
+It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://docs.openbb.co/terminal/quickstart/installation) to download the most recent release.
+
+Do note that it is also possible that the menu or command has been deprecated. If this is oversight, please reach out to us [here](https://openbb.co/support).
+
+How often are patches for bugs released?
+
+The installer versions are packaged approximately every two-weeks. Those working with a cloned GitHub version can checkout the Develop branch to get the latest fixes and releases before they are pushed to the main branch.
+
+```console
+git checkout develop
+```
+
+How do I report a bug?
+
+First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D)
+
+How can I get help with OpenBB Terminal?
+
+You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support).
+
+How can I give feedback about the OpenBB Terminal, or request specific functionality?
+
+Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model.
+
+You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`).
+
+Alternatively, you can contact us via the following routes:
+
+- If you notice that a feature is missing inside the terminal, please fill in the [Request a Feature](https://openbb.co/request-a-feature) form.
+- If you wish to report a bug, have a question/suggestion or anything else, please fill in the [Support](https://openbb.co/support) form.
+- If you wish to speak to us directly, please contact us on [Discord](https://openbb.co/discord).
+
+Error: "git pull" fails because of a hot fix: cannot lock ref
+
+If the error message looks something like:
+
+```console
+cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create
+```
+
+Try:
+
+```console
+git remote prune origin
+git pull
+```
+
+What does it mean if it says wheel is missing?
+
+If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing.
+
+`conda install -c conda-forge wheel` or `pip install wheel`
+
+Why do these .whl files not exist?
+
+If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder.
+Just removing the 'artifacts' folder could also be enough:
+
+| Platform | Location |
+| -------- | ------------------------------- |
+| Linux | "~/.cache/pypoetry" |
+| Mac | "~/Library/Caches/pypoetry" |
+| Windows | "%localappdata%/pypoetry/cache" |
+
+When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the
+'artifacts' folder again to reinitialize Poetry.
+
+If you run into trouble with Poetry, and the advice above did not help, your best bet is to try
+
+- `poetry update --lock`
+- `conda deactivate` -> `conda activate obb`, then try again
+- Track down the offensive package and purge it from your anaconda `` folder, then try again
+
+| Platform | Location |
+| --------- | ------------------------------------------- |
+| Linux/Mac | ~/anaconda3/envs, or , ~/opt/anaconda3/envs |
+| Windows | %userprofile%/anaconda3/envs |
+
+- Completely nuke your conda environment folder and make a new environment from scratch
+
+ - `conda deactivate`
+ - `conda env remove -n obb`
+ - `conda clean -a`
+ - Make a new environment and install dependencies again.
+- Reboot your computer and try again
+- Submit a ticket on GitHub
+
+What does the JSONDecodeError mean during poetry install?
+
+Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process.
+
+```bash
+poetry config experimental.new-installer false
+```
+
+_Commands that may help you in case of an error:_
+
+- `python -m pip install --upgrade pip`
+- `poetry update --lock`
+- `poetry install`
+
+How do I deal with errors regarding CRLF?
+
+When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to
+CRLF (default for Windows).
+This is because the entire package uses LF (default for Linux/Mac), and it is therefore
+important that you change this setting to LF _before_ you make any changes to the code.
+
+It is possible that CRLF automatically turns back on, you can correct this with:
+
+```bash
+git config --global core.autocrlf false
+```
+
+In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with
+the following:
+
+```bash
+git rm --cached -r .
+git reset --hard
+```
+
+Why can't I run OpenBB via the VS Code integrated terminal?
+
+This occurs when VS Code terminal python version/path is different from the terminal version.
+
+To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)):
+
+```bash
+ "terminal.integrated.inheritEnv": false,
+```
+
+