From 970b31dea67adc1b1068ee4e46cd1800df5e92b1 Mon Sep 17 00:00:00 2001 From: didier Date: Sun, 25 Apr 2021 10:30:44 +0100 Subject: [PATCH 1/6] start adding troubleshoot file --- README.md | 74 +++++++-------------------------------- TROUBLESHOOT.md | 93 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 106 insertions(+), 61 deletions(-) create mode 100644 TROUBLESHOOT.md diff --git a/README.md b/README.md index 42aba5d5482..9e90029e418 100644 --- a/README.md +++ b/README.md @@ -110,26 +110,30 @@ conda create -n gst python=3.6.8 ``` conda activate gst ``` -Note: At the end, you can deactivate it with: `conda deactivate` +Note: At the end, you can deactivate it with: `conda deactivate`. 4. Install git ``` conda install -c anaconda git ```` -5. Fork the Project +5. Clone the Project - Via HTTPS: `git clone https://github.com/DidierRLopes/GamestonkTerminal.git` - via SSH: `git clone git@github.com:DidierRLopes/GamestonkTerminal.git` -Navigate into the folder with: `cd GamestonkTerminal/` +6. Navigate into the project's folder -6. Install poetry +``` +cd GamestonkTerminal/ +``` + +7. Install poetry ``` conda install poetry ``` -6.5. If installing python 3.8 +7.5. If installing python 3.8 ``` conda deactivate conda activate gst @@ -137,18 +141,20 @@ conda activate gst *The `conda deactivate` -> `conda activate` in the middle is on purpose, this is sometimes required to avoid issues with poetry* -7. Install poetry dependencies +8. Install poetry dependencies ``` poetry install ``` This is a library for package management, and ensures a smoother experience than: ``pip install -r requirements.txt`` -8. You're ready to Gamestonk it! +9. You're ready to Gamestonk it! ``` python terminal.py ``` +**NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate gst` before you call `python terminal.py` again. + ### Advanced User Install - Machine Learning If you are an advanced user and use other Python distributions, we have several requirements.txt documents that you can pick from to download project dependencies. @@ -166,13 +172,6 @@ ENABLE_PREDICT = os.getenv("GTFF_ENABLE_PREDICT") or True ``` poetry install -E prediction ``` -*If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this:* - -``` -conda install -c conda-forge fbprophet numpy=1.19.5 hdf5=1.10.5 -poetry install -poetry install -E prediction -``` *If you would like to set up a docker image:* @@ -181,53 +180,6 @@ poetry install -E prediction Note: The problem with docker is that it won't output matplotlib figures. -*Commands that may help you in case of an error: - -* `python -m pip install --upgrade pip` -* `pip install pystan --upgrade` -* `poetry update --lock` - -### Other Issues - -If you run into trouble with poetry and the advice above did not help, your best bet is to try - -1. `poetry update --lock` - -2. `conda deactivate` -> `conda activate gst`, then try again - -3. Delete the poetry cache, then try again - - | Platform | Location | - | -------- | ------------------------------- | - | Linux | "~/.cache/pypoetry" | - | Mac | "~/Library/Caches/pypoetry" | - | Windows | "%localappdata%/pypoetry/cache" | - -4. Track down the offensive package and purge it from your anaconda `` folder, then try again (removing through conda can sometimes leave locks behind) - - | Platform | Location | - | --------- | -------------------------------------------- | - | Linux/Mac | "~/anaconda3/envs" or "~/opt/anaconda3/envs" | - | Windows | "%userprofile%/anaconda3/envs" | - -5. Completely nuke your conda environment folder and make a new environment from scratch - -6. Reboot your computer and try again - -7. Submit a ticket on github - -### ModuleNotFoundError - -In the case when you run into an error of the form `ModuleNotFoundError: No module named '_______'`. The solution is to -install the missing package via pip. - -If you get the error that `statsmodels` is not found, you would run -* `pip install statsmodels` - -Then please submit an issue so that we can address why that was not imported. - -Please note that the package `pmdarima` needs to installed through `pip install` and not through `conda install`. - ### Update Terminal The terminal is constantly being updated with new features and bug fixes, hence, for your terminal to be update, you can run: diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md new file mode 100644 index 00000000000..38f6df4cccc --- /dev/null +++ b/TROUBLESHOOT.md @@ -0,0 +1,93 @@ + +# TROUBLESHOOT + +If you are visiting this page it means that you're having issues installing. We apologize for that. + +Since the start of the project we've come across different types of issues experienced by the users. This page tries to combine issues, and their solutions. This will allow to give the best install experience to everyone regardless of any programming skills. + +
    +
  1. + Standard Install Troubles: + +
    2. +
  2. + ModuleNotFound Trouble: + +
    3. +
  3. + Machine Learning Troubles: + +
    4. +
  4. + Other Troubles: + +
    5. +
+ + +## Standard Install + +### Other Issues + +If you run into trouble with poetry and the advice above did not help, your best bet is to try + +1. `poetry update --lock` + +2. `conda deactivate` -> `conda activate gst`, then try again + +3. Delete the poetry cache, then try again + + | Platform | Location | + | -------- | ------------------------------- | + | Linux | "~/.cache/pypoetry" | + | Mac | "~/Library/Caches/pypoetry" | + | Windows | "%localappdata%/pypoetry/cache" | + +4. Track down the offensive package and purge it from your anaconda `` folder, then try again (removing through conda can sometimes leave locks behind) + + | Platform | Location | + | --------- | -------------------------------------------- | + | Linux/Mac | "~/anaconda3/envs" or "~/opt/anaconda3/envs" | + | Windows | "%userprofile%/anaconda3/envs" | + +5. Completely nuke your conda environment folder and make a new environment from scratch + +6. Reboot your computer and try again + +7. Submit a ticket on github + +### ModuleNotFoundError + +In the case when you run into an error of the form `ModuleNotFoundError: No module named '_______'`. The solution is to +install the missing package via pip. + +If you get the error that `statsmodels` is not found, you would run +* `pip install statsmodels` + +Then please submit an issue so that we can address why that was not imported. + +Please note that the package `pmdarima` needs to installed through `pip install` and not through `conda install`. + +### Generic + +If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this: + +``` +conda install -c conda-forge fbprophet numpy=1.19.5 hdf5=1.10.5 +poetry install +poetry install -E prediction +``` + +*Commands that may help you in case of an error:* + +* `python -m pip install --upgrade pip` +* `pip install pystan --upgrade` +* `poetry update --lock` From 6125b2101623ae088f52f2a3a2b8f9982803725c Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Sun, 25 Apr 2021 10:53:51 +0100 Subject: [PATCH 2/6] Update TROUBLESHOOT.md --- TROUBLESHOOT.md | 165 ++++++++++++++++++++++++++++++++---------------- 1 file changed, 109 insertions(+), 56 deletions(-) diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md index 38f6df4cccc..62c96a3d998 100644 --- a/TROUBLESHOOT.md +++ b/TROUBLESHOOT.md @@ -1,41 +1,122 @@ # TROUBLESHOOT -If you are visiting this page it means that you're having issues installing. We apologize for that. +If you are visiting this page it means that you're having issues installing. We deeply apologize for that. Since the start of the project we've come across different types of issues experienced by the users. This page tries to combine issues, and their solutions. This will allow to give the best install experience to everyone regardless of any programming skills.
    -
  1. - Standard Install Troubles: - -
    2. -
  2. - ModuleNotFound Trouble: - -
    3. -
  3. - Machine Learning Troubles: - -
    4. -
  4. - Other Troubles: - -
    5. -
+
  • + Standard Install Troubles: + +
    • +
  • + ModuleNotFoundError Trouble: + +
    • +
  • + Machine Learning Troubles: + +
    • +
  • + Other Troubles: + +
    • + -## Standard Install +## Standard Install Troubles -### Other Issues +### Microsoft Visual C++ + +If your terminal has too many red error lines, it is likely that this is the issue. Go to this page and install the c++ build tools: +https://answers.microsoft.com/en-us/windows/forum/windows_other-windows_install/microsoft-visual-c-140/6f0726e2-6c32-4719-9fe5-aa68b5ad8e6d + + +### Wheel + +`conda install -c conda-forge wheel` or `pip install wheel` + + +### Cvxpy + +``` +conda install -c conda-forge cvxpy +``` + +### Numpy + +``` +pip install --upgrade numpy==1.20.2 +``` + + +## ModuleNotFoundError Trouble + +### General + +In the case when you run into an error of the form `ModuleNotFoundError: No module named '_______'`. The solution is to +install the missing package via pip. + +If you get the error that `yfinance` is not found, you would run +* `pip install yfinance` + +Then please submit an issue so that we can address why that was not imported. + +Please note that the package `pmdarima` needs to installed through `pip install` and not through `conda install`. + +### pypfopt +``` +pip install PyPortfolioOpt +``` + +### dotenv +``` +pip install python-dotenv +``` + +### ally +``` +pip install pyally +``` + + +## Machine Learning Troubles + +### General + +If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this: + +``` +conda install -c conda-forge fbprophet numpy=1.19.5 hdf5=1.10.5 +poetry install +poetry install -E prediction +``` + +*Commands that may help you in case of an error:* + +* `python -m pip install --upgrade pip` +* `pip install pystan --upgrade` +* `poetry update --lock` + + +## Other Issues + +### General If you run into trouble with poetry and the advice above did not help, your best bet is to try @@ -63,31 +144,3 @@ If you run into trouble with poetry and the advice above did not help, your best 6. Reboot your computer and try again 7. Submit a ticket on github - -### ModuleNotFoundError - -In the case when you run into an error of the form `ModuleNotFoundError: No module named '_______'`. The solution is to -install the missing package via pip. - -If you get the error that `statsmodels` is not found, you would run -* `pip install statsmodels` - -Then please submit an issue so that we can address why that was not imported. - -Please note that the package `pmdarima` needs to installed through `pip install` and not through `conda install`. - -### Generic - -If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this: - -``` -conda install -c conda-forge fbprophet numpy=1.19.5 hdf5=1.10.5 -poetry install -poetry install -E prediction -``` - -*Commands that may help you in case of an error:* - -* `python -m pip install --upgrade pip` -* `pip install pystan --upgrade` -* `poetry update --lock` From c164642ffba474c78219f7d96ca47dd5f1168ee7 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Sun, 25 Apr 2021 10:55:22 +0100 Subject: [PATCH 3/6] Update TROUBLESHOOT.md --- TROUBLESHOOT.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md index 62c96a3d998..e9bb37498b0 100644 --- a/TROUBLESHOOT.md +++ b/TROUBLESHOOT.md @@ -7,7 +7,7 @@ Since the start of the project we've come across different types of issues exper
    1. - Standard Install Troubles: + Standard Install Troubles
      • Microsoft Visual C++
      • Wheel
        • @@ -16,7 +16,7 @@ Since the start of the project we've come across different types of issues exper
    2. - ModuleNotFoundError Trouble: + ModuleNotFoundError Trouble
      • General
      • pypfopt
        • @@ -25,16 +25,10 @@ Since the start of the project we've come across different types of issues exper
    3. - Machine Learning Troubles: - + Machine Learning Troubles
    4. - Other Troubles: - + Other Issues
    @@ -95,9 +89,7 @@ pip install pyally ``` -## Machine Learning Troubles - -### General +## Machine Learning Trouble If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this: @@ -114,9 +106,7 @@ poetry install -E prediction * `poetry update --lock` -## Other Issues - -### General +### Other Issues If you run into trouble with poetry and the advice above did not help, your best bet is to try From af4d6a192ff5e669ae83dcb750ced395ed2d6685 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Sun, 25 Apr 2021 10:57:03 +0100 Subject: [PATCH 4/6] Update TROUBLESHOOT.md --- TROUBLESHOOT.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md index e9bb37498b0..10ba238ef0a 100644 --- a/TROUBLESHOOT.md +++ b/TROUBLESHOOT.md @@ -9,7 +9,7 @@ Since the start of the project we've come across different types of issues exper
  • Standard Install Troubles
      -
    • Microsoft Visual C++
      • +
    • Microsoft Visual C++
    • Wheel
    • Cvxpy
    • Numpy
      • @@ -89,7 +89,7 @@ pip install pyally ``` -## Machine Learning Trouble +### Machine Learning Troubles If you run into issues installing or `Cannot convert a symbolic Tensor...` at runtime, try this: From 9299fb956ea772ac712458e0ef40b1a2f5c5c5c4 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Sun, 25 Apr 2021 10:59:51 +0100 Subject: [PATCH 5/6] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e90029e418..e1aadc5d78a 100644 --- a/README.md +++ b/README.md @@ -59,8 +59,6 @@
      • Install
      • Advanced User Install - Machine Learning
        • -
      • Other Issues
        • -
      • ModuleNotFoundError
      • Update Terminal
      • API Keys
      • Usage
        • @@ -140,7 +138,6 @@ conda activate gst ``` *The `conda deactivate` -> `conda activate` in the middle is on purpose, this is sometimes required to avoid issues with poetry* - 8. Install poetry dependencies ``` poetry install @@ -155,6 +152,8 @@ python terminal.py **NOTE:** When you close the terminal and re-open it, the only command you need to re-call is `conda activate gst` before you call `python terminal.py` again. +**TROUBLESHOOT:** If you are having troubles to install, check our *newest* troubleshoot page + ### Advanced User Install - Machine Learning If you are an advanced user and use other Python distributions, we have several requirements.txt documents that you can pick from to download project dependencies. From d7287c20489913aa4e17bf4d463e246ef79b3fc1 Mon Sep 17 00:00:00 2001 From: DidierRLopes Date: Sun, 25 Apr 2021 11:25:21 +0100 Subject: [PATCH 6/6] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e1aadc5d78a..4679c7cbb53 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,11 @@ This project was originally written and tested with Python 3.6.8. It should now Our current recommendation is to use this project with Anaconda's Python distribution - either full [__Anaconda3 Latest__](https://repo.anaconda.com/archive/) or [__Miniconda3 Latest__](https://repo.anaconda.com/archive/). Several features in this project utilize Machine Learning. Machine Learning Python dependencies are optional. If you decided to add Machine Learning features at a later point, you will likely have better user experience with Anaconda's Python distribution. +0. Star the project + +Captura de ecrã 2021-04-25, às 01 13 30 + + 1. Install Anaconda Confirm that you have it with: `conda -V`. The output should be something along the lines of: `conda 4.9.2`