Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document sage installation method with pip #35070

Merged
merged 10 commits into from
Mar 13, 2023
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,18 @@ in the Installation Guide.
or JupyterLab installation, as described in [section
"Launching SageMath"](https://doc.sagemath.org/html/en/installation/launching.html)
in the installation manual.

Alternative Installation using PiPy
mkoeppe marked this conversation as resolved.
Show resolved Hide resolved
---------------
mkoeppe marked this conversation as resolved.
Show resolved Hide resolved
mkoeppe marked this conversation as resolved.
Show resolved Hide resolved

You can find `sage` and `sagemath` pip packages but it is worth nothing that they are not at all realted to this `sage`. Indeed `pip install sage` installs `sage 0.0.0` which is literally an empty package. For installation of this `sage` you need to install `sagemath-standard`. First activate your python virtual environment and follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it is needed to talk about these packages.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These packages are very misleading during sage installation in a python virtual environment and the sources on the internet do not explain clearly about the installation of sage package using pip.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least don't start the writing with what shouldn't be done. And nobody needs to know in what specific way these packages are unsuitable. As simple "(Ignore the sage and sagemath packages on PyPI.)" should be enough.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Thank you

Copy link
Contributor Author

@zovelsanj zovelsanj Feb 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps a note would be better to avoid this ambiguity of sage and sagemath in PyPi.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we should contact the maintainer of the empty sage package, @dhagrow, and ask if they would mind transferring the name to the SageMath org somehow (unsure if this ping here does anything but it's fairly easy to find an associated email address for that user on google if we did want to get in conact if desired).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's #28796.


$ python3 -m pip install sage_conf
$ ls $(sage-config SAGE_SPKG_WHEELS)
$ python3 -m pip install $(sage-config SAGE_SPKG_WHEELS)/*.whl
$ python3 -m pip install sagemath-standard

You need to install the `sage_conf`, a wheelhouse of various python packages. You can list the wheels using `ls $(sage-config SAGE_SPKG_WHEELS)`. After manual installation of these wheels you can install the sage library, `sagemath-standard`.

Troubleshooting
---------------
Expand Down