Update conda instructions #39515
Update conda instructions #39515
Conversation
mamba is great, and it's sometimes a bit faster than conda still. But conda has finally upgraded their solver so the conda solver works perfectly fine for our purposes.
it's figured out correctly automatically on Linux on macOS (tested at SD128.)
most people reading this probably have no idea what channels are.
| @@ -156,5 +131,5 @@ To build the documentation, use:: | |||
|
|
|||
| You can update the conda lock files by running | |||
| ``.github/workflows/conda-lock-update.py`` or by running | |||
| ``conda-lock --platform linux-64 --filename environment-3.11-linux.yml --lockfile environment-3.11-linux.lock`` | |||
| ``conda-lock --platform linux-64 --filename environment-3.12-linux.yml --lockfile environment-3.12-linux.lock`` | |||
There was a problem hiding this comment.
I updated some strings in this file. Not that it really matters but maybe it is going to keep the commands valid literally for a little bit longer.
This comment was marked as resolved.
This comment was marked as resolved.
|
@mantepse, the instructions here seem to work on macOS/Linux. |
src/doc/en/installation/conda.rst
Outdated
|
|
||
| $ conda env update --file environment-3.12-linux.yml | ||
|
|
||
| If you want to use Jupyter notebooks, you need to install JupyterLab and the SageMath kernel:: |
There was a problem hiding this comment.
I'm not sure if it's possible to do this, but if it is could you also explain how to create a Jupyter kernel for use in an existing/system Jupyter installation? This is something I've had trouble doing in conda so if there's a way to do it it would be nice to document.
There was a problem hiding this comment.
That's more complicated. You need to wrap things into an activation script and it's going to end up being more brittle. I am not sure whether I would want to advertise this here. (And I also don't want to test whether these instructions really work on Linux/macOS or even WSL.)
|
Looks good, just waiting for the CI-generated documentation preview to finish so I can verify there are no formatting issues before marking as positive review. |
|
Doc build failure seems relevant. The logs say something about an issue with the code/literal blocks in the file you're modifying here, so I'd start with checking those. |
|
|
||
| where ``X`` is version of Python, e.g. ``3.9``. | ||
| $ conda create -n sage sage |
There was a problem hiding this comment.
If you only keep one, I recommend using mamba. It's drop-in replacement and much faster.
There was a problem hiding this comment.
I personally use mamba but conda works just fine and it is available on the setups that we are covering here (see the top) i.e., also on miniconda and anaconda.
There was a problem hiding this comment.
I agree with maintaining conda instructions as I think it's a bit more widely available in various distro repositories. No opinion on keeping both or having just conda.
| @@ -73,51 +57,36 @@ environment for Sage development. | |||
|
|
|||
| Here we assume that you are using a git checkout. | |||
|
|
|||
| - Optionally, set the build parallelism for the Sage library. Use | |||
There was a problem hiding this comment.
think about it, why does this section even exist? isn't https://doc-release--sagemath.netlify.app/html/en/installation/meson enough?
There was a problem hiding this comment.
Yes, eventually this section should be removed. But I understood that the meson setup isn't sufficiently stable and some people are using the setup described here.
@tobiasdiez @dimpase do you think that the meson setup should be recommended for everybody that uses conda dependencies and we should just remove this page altogether?
There was a problem hiding this comment.
It's been a few months since I tried using the meson setup but I remember having issues with it.
|
Documentation preview for this PR (built with commit 6b742c6; changes) is ready! 🎉 |
|
There's a formatting issue, some of the text is appearing in code blocks: https://doc-pr-39515--sagemath.netlify.app/html/en/installation/conda |
Sorry for making such silly mistakes in this PR. I'll try to review it myself quickly when the docbuild is ready. |
while that statement might be technically true somehow, I think for most people this just "builds" Sage. That it is "installed" somehow is maybe misleading.
The conda instructions are a bit more complicated than they have to be. They also mention some things that are deprecated (Mambaforge) or uncessary (mamba).
Here, we try to simplify the instructions with the experience we had by running installations on SageDays 128.
📝 Checklist