Document sage installation method with pip by zovelsanj · Pull Request #35070 · sagemath/sage

zovelsanj · 2023-02-11T06:37:30Z

📚 Description

📝 Checklist

I have made sure that the title is self-explanatory and the description concisely explains the PR.
I have linked an issue or discussion.
I have created tests covering the changes.
I have updated the documentation accordingly.

⌛ Dependencies

Added sage library installation instructions using pip. Installing sage in a python virtual environment can be troublesome as `sage` and `sagemath` libraries, not at all related to this sage, exist in PiPy.

updated sage installation method with pip

zovelsanj · 2023-02-11T06:40:55Z

Added sage library installation instructions using pip. Installing sage in a python virtual environment can be troublesome as sage and sagemath libraries, not at all related to this sage, exist in PiPy.

README.md

mkoeppe · 2023-02-11T06:50:54Z

README.md

+Alternative Installation using PiPy
+---------------
+
+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:


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

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.

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.

Agreed. Thank you

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

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).

That's #28796.

Fixed the pip installation instructions according to this [comment](sagemath#35070 (comment)).

README.md

changed `PiPy` to 'PyPi'

README.md

changed PyPi tp PyPI

alexjbest · 2023-02-11T11:32:13Z

README.md

+Alternative Installation using PyPI
+---------------
+
+For installation of `sage` in python using `pip` you need to install `sagemath-standard`. First, activate your python virtual environment and follow these steps:


Suggested change

For installation of `sage` in python using `pip` you need to install `sagemath-standard`. First, activate your python virtual environment and follow these steps:

For installation of `sage` in python using `pip` you need to install `sagemath-standard`. First, activate your python virtual environment and follow these steps:

README.md

mkoeppe · 2023-02-11T07:48:22Z

README.md

+
+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`. 
+
+**NOTE:** You can find `sage` and `sagemath` pip packages but it is worth noting that they are not at all related to this `sage`. Indeed `pip install sage` installs `sage 0.0.0` which is literally an empty package. 


These packages are actually related to SageMath, but they are not useful.
Please reduce

After installing sage and sagemath with pip and importing sage it throws an import error: No module named sage.
I don't understand how they are related to sage if they can't import sage at all. Please refer to this post on stackoverflow.

There's nothing deep to understand here. Both packages were created because the respective authors intended to provide some functionality related to SageMath. But neither of the two packages can be used to install SageMath, so they should be ignored.

Ok, I will update the readme

mkoeppe · 2023-02-11T19:05:44Z

README.md

+Alternative Installation using PiPy
+---------------
+
+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:


That's #28796.

updated the ambiguity note on `sage` and `sagemath` as per [sagemath#35070](sagemath#35070 (comment))

mkoeppe · 2023-02-12T15:54:20Z

README.md

 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`. 

-**NOTE:** You can find `sage` and `sagemath` pip packages but it is worth noting that they are not at all related to this `sage`. Indeed `pip install sage` installs `sage 0.0.0` which is literally an empty package. 
+**NOTE:** You can find `sage` and `sagemath` pip packages but it is worth noting that when importing `sage` with these packages you will encounter `ModuleNotFoundError: No module named 'sage'`. Indeed `pip install sage` installs `sage 0.0.0` which is literally an empty package. 


Still too much information.

reduced the information.

Reduced `sage` and `sagemath` information as per [sagemath#35070](sagemath#35070 (comment))

Co-authored-by: Alex J Best <alex.j.best@gmail.com>

mkoeppe

LGTM now, thanks!

github-actions · 2023-02-15T07:53:05Z

Documentation preview for this PR is ready! 🎉
Built with commit: ee2149d

codecov-commenter · 2023-02-15T09:05:45Z

Codecov Report

Base: 88.59% // Head: 88.58% // Decreases project coverage by -0.01% ⚠️

Coverage data is based on head (ee2149d) compared to base (fbb4127).
Patch has no changes to coverable lines.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #35070      +/-   ##
===========================================
- Coverage    88.59%   88.58%   -0.01%     
===========================================
  Files         2140     2140              
  Lines       396961   396961              
===========================================
- Hits        351677   351643      -34     
- Misses       45284    45318      +34

Impacted Files	Coverage Δ
...e/combinat/cluster_algebra_quiver/mutation_type.py	`49.88% <0.00%> (-3.09%)`	⬇️
src/sage/cpython/_py2_random.py	`75.20% <0.00%> (-1.24%)`	⬇️
src/sage/modular/hecke/algebra.py	`94.65% <0.00%> (-1.07%)`	⬇️
src/sage/combinat/posets/poset_examples.py	`87.67% <0.00%> (-1.01%)`	⬇️
src/sage/sets/integer_range.py	`91.41% <0.00%> (-0.51%)`	⬇️
src/sage/modular/arithgroup/arithgroup_perm.py	`92.57% <0.00%> (-0.38%)`	⬇️
src/sage/modular/overconvergent/hecke_series.py	`98.76% <0.00%> (-0.31%)`	⬇️
src/sage/rings/function_field/ideal.py	`89.47% <0.00%> (-0.17%)`	⬇️
src/sage/combinat/posets/lattices.py	`92.26% <0.00%> (-0.10%)`	⬇️
src/sage/graphs/generic_graph.py	`89.04% <0.00%> (-0.08%)`	⬇️
... and 11 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

zovelsanj added 2 commits February 10, 2023 20:45

updated sage installation method with pip

6e5e52e

Added sage library installation instructions using pip. Installing sage in a python virtual environment can be troublesome as `sage` and `sagemath` libraries, not at all related to this sage, exist in PiPy.

Merge pull request #1 from zovelsanj/zovelsanj-patch-1

ec867ac

updated sage installation method with pip