update install instructions #57
Conversation
|
@MathewBiddle do you mind taking a look at the changes here? If you could try to follow them and check if they are clear enough, even better :-) |
|
Added some comments in specific lines. With all the hyperlinks I was wondering if there was a GHA to check links on a .md page (or from the .html in |
Sphinx has a check link tool. I'll see if that is available on Jupyter book too. |
If you made it like a "review" did you submit it? I cannot see the comments yet. |
|
|
||
| ### What to do when everything seems to be broken? | ||
|
|
||
| 1. If you believe that only your environment is broken you can follow the [update environment](##Updating-the-IOOS-environment) instructions from above; |
There was a problem hiding this comment.
This should be a link to #updating-the-ioos-environment
There was a problem hiding this comment.
Thanks! Vscode fooled me there by creating the link that didn't point to the right section :-)
|
|
||
| 1. If you believe that only your environment is broken you can follow the [update environment](##Updating-the-IOOS-environment) instructions from above; | ||
| 1. Sometimes conda updates can break backwards compatibility and updating is broken. In those cases remove the Miniforge3 directory and perform a fresh install of the new version. | ||
| 1. In rare cases you may want to install a frozen version of the environment. Like, you need the exact same version that is running on our CIs. You can accomplish that by [downloading the lock file your your system](https://github.com/ioos/ioos_code_lab/tree/main/.binder) and issuing the command: |
There was a problem hiding this comment.
- double
your. - Might want to include a file name description/explanation for the lock file, so folks know which to download.
There was a problem hiding this comment.
Might want to include a file name description/explanation for the lock file, so folks know which to download.
I tried to make it a bit clearly below. Let me know if that is better.
|
|
||
| 1. If you did not install Miniforge on your C:\ drive you may have a "long path error." Usually that happens when you see failures in the environment creation; | ||
| 1. Installed is "successful" but nothing was installed. Please see https://github.com/ContinuumIO/anaconda-issues/issues/6258 for some reasons to why that us happening. Most common ones are aggressive anti-virus or bank apps blocking the installation; | ||
| 1. Installation was successful but calling `jupyter notebook` just hangs while "waiting for localhost:" that is probably a firewall setting blocking the notebook or you need to update your packages. See [update environment](##Updating-the-IOOS-environment). |
There was a problem hiding this comment.
Check the hyperlink, should be #updating-the-ioos-environment.
| a lightweight version of the [Anaconda Scientific Python Distribution](https://store.continuum.io/cshop/anaconda/). | ||
| For IOOS Python/R users we recommend the free | ||
| [Miniforge](https://github.com/conda-forge/miniforge) distribution, | ||
| a lightweight version of the [Anaconda Scientific Python Distribution](https://store.continuum.io/cshop/anaconda/) with the conda-forge channel pre-configured. |
There was a problem hiding this comment.
So, now we recommend Miniforge? Do we still want to include Miniconda information in here as well? Does it make a difference to the end user?
Towards the bottom I see references to Miniconda, it might be good to make this all consistent with our current recommendations. If Miniconda is no longer recommended, lets say why and update everything to Miniforge.
There was a problem hiding this comment.
So, now we recommend Miniforge?
Yep. Mostly b/c of: https://www.anaconda.com/terms-of-service
Do we still want to include Miniconda information in here as well?
Everything is virtually identical. Not sure it is worth mentioning it. If folks need miniconda for any reason they can use this instructions. The only differences are that they need to add the conda-forge channel manually and activate strict channel option.
Does it make a difference to the end user?
Besides the new TOS the difference are that they need to add the conda-forge and activate strict channel.
|
Sorry about that, just submitted it. |
Closes #54