You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
gh-37261: `README.md`: Improve PyPI install instructions
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
Based on https://groups.google.com/g/sage-devel/c/1viBzw-
ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI.
We also improve **sage_conf** so that `python3 -m sage_conf` is
equivalent to `sage-config`.
After the next stable release is out, we can use this to simplify these
installation instructions.
Blocker because we need this to go in the 10.3 stable release.
<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->
### 📝 Checklist
<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->
- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.
### ⌛ Dependencies
<!-- List all open PRs that this PR logically depends on
- #12345: short description why this is a dependency
- #34567: ...
-->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
URL: #37261
Reported by: Matthias Köppe
Reviewer(s):
Copy file name to clipboardExpand all lines: README.md
+38-7Lines changed: 38 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -420,16 +420,47 @@ in the Installation Guide.
420
420
Alternative Installation using PyPI
421
421
---------------
422
422
423
-
For installation of `sage` in python using `pip` you need to install `sagemath-standard`. First, activate your python virtual environment and follow these steps:
423
+
For installing Sage in a Python environment from PyPI, Sage provides the
Unless you need to install Sage into a specific existing environment, we recommend
427
+
to create and activate a fresh virtual environment, for example `~/sage-venv/`:
429
428
430
-
You need to install `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`.
429
+
$ python3 -m venv ~/sage-venv
430
+
$ source ~/sage-venv/bin/activate
431
431
432
-
**NOTE:** You can find `sage` and `sagemath` pip packages but with these packages, you will encounter `ModuleNotFoundError`.
432
+
As the first installation step, install [sage_conf](https://pypi.org/project/sage-conf/),
433
+
which builds various prerequisite packages in a subdirectory of `~/.sage/`:
434
+
435
+
(sage-venv) $ python3 -m pip install -v sage_conf
436
+
437
+
After a successful installation, a wheelhouse provides various Python packages.
438
+
You can list the wheels using the command:
439
+
440
+
(sage-venv) $ ls $(sage-config SAGE_SPKG_WHEELS)
441
+
442
+
If this gives an error saying that `sage-config` is not found, check any messages
443
+
that the `pip install` command may have printed. You may need to adjust your `PATH`,
0 commit comments