docs: Unify Installation #1184
docs: Unify Installation #1184
Conversation
This branch is supposed to only edit the docs.
I put in some examples with the output showing, not just the input. Turns out, sphinx-copybutton can handle this, if you give it a regex to work with.
Just link to the maintained copy instead.
|
|
||
| .. tabs:: | ||
| python -m venv venv |
There was a problem hiding this comment.
Maybe
| python -m venv venv | |
| python -m venv ivadomed_venv |
but then that makes
ivadomed/ivadomed_venv
which is weird. And also .gitignore already had an entry for venv/. So if we change this we should change that too.
| .. note:: | ||
|
|
||
| 1. Set up Python Venv Virtual Environment. | ||
| If you are installing into your home folder (``pip install --user``), which is the default, | ||
| you need to make sure that ``~/.local/bin/`` (or ``%APPDATA%\Python\PythonXY\Scripts`` on Windows) | ||
| is on your ``$PATH`` for ivadomed's tools to be available. ``pip`` will warn you if it is not. | ||
| It should be pre-configured properly on Ubuntu and most common Linux distros. | ||
|
|
||
| ``ivadomed`` requires Python >= 3.7 and <3.10. First, make sure that a | ||
| compatible version of Python 3 is installed on your system by running: | ||
| If you are installing into a `venv <https://docs.python.org/3/library/venv.html>`_ or a | ||
| `conda env <https://docs.conda.io/projects/conda/en/latest/commands.html#conda-vs-pip-vs-virtualenv-commands>`_ | ||
| then the tools will be available whenever that environment is activated. |
There was a problem hiding this comment.
Maybe this note would be better in a separate Troubleshooting section. 80% of people will be fine, it's only people on like, ArchLinux or Gentoo or Alpine that might have this problem, and it's a one-time fix for them too so they might already have fixed it before they try to install us.
|
|
||
| .. group-tab:: Windows | ||
| pip install ivadomed --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu102 |
There was a problem hiding this comment.
In axondeepseg/axondeepseg#642 I instead recommended people put this into pip.conf. I am leaning towards that being a better recommendation because the choice of which download.pytorch.org link to use really depends on people's hardware, and that doesn't change as rapidly as software, and if any other software they use uses pytorch...they're going to want to make the same call as for what build they want.
| pip install ivadomed --force-reinstall \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu110 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu111 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu112 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu113 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu114 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu115 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu116 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu117 \ | ||
| --extra-index-url https://download.pytorch.org/whl/cu118 |
There was a problem hiding this comment.
This is some edits to how I think #1125 should look (if merged this will merge into that PR). I thought showing what I had in mind would be easier than trying to back-seat drive as a reviewer.