Skip to content

Commit 6ccf0a2

Browse files
committed
README.md: Add installation instructions using passagemath
1 parent 7399f40 commit 6ccf0a2

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,14 @@ The **sage-euler-product** package for SageMath adds functionality related to Nu
1919

2020
Installing sage-euler-product requires a working Sage installation.
2121

22-
## Installation
22+
## Installation from PyPI in an existing Sage installation built from source
2323

24-
The module is distributed on PyPI and is easily installed through the Python package manager pip. If you downloaded a binary from the SageMath website (including the Cygwin version running on Windows) or compiled from source, run the following command:
24+
The module is distributed on PyPI and is easily installed through the Python package manager pip.
25+
Switch to the source directory (SAGE_ROOT) of your Sage installation, and run the following command:
2526

2627
$ sage -pip install sage-euler-product [--user]
2728

28-
The --user option is optional and allows to install the module in your user space (and does not require administrator rights).
29+
The `--user` option is optional and allows to install the module in your user space (and does not require administrator rights).
2930

3031
If you use Debian or Ubuntu and you installed Sage through the operating system's package manager (that is, the package sagemath), run these two commands:
3132

@@ -34,7 +35,8 @@ If you use Debian or Ubuntu and you installed Sage through the operating system'
3435

3536
If you use Arch Linux, you need to install from source (see next section).
3637

37-
Install and use source version
38+
## Installation of the development version from GitHub in an existing Sage installation
39+
3840
This section provides detailed instructions on how to download, modify and install the development version of **sage-euler-product**. In all commands,
3941

4042
PIP has to be replaced by either pip, pip2, or sage -pip
@@ -72,6 +74,30 @@ The result of the command must correspond to the path of the repository created
7274

7375
If you wish to install your custom version of sage-euler-product just use PIP as indicated before.
7476

77+
## Installation in a virtual Python environment (no prior Sage installation required)
78+
79+
Create and activate a virtual environment:
80+
81+
python3 -m venv venv-euler-product
82+
. venv-euler-product/bin/activate
83+
84+
Install the package in the virtual environment:
85+
86+
pip install "sage-euler-product[passagemath] @ git+https://github.com/archimede-institut/sage-euler-product
87+
88+
This automatically installs the modularized parts of the Sage library that are
89+
needed by the package. (These modularized distributions are provided by
90+
https://github.com/passagemath.)
91+
92+
Next, start Sage:
93+
94+
rehash
95+
sage
96+
97+
At the Sage prompt, load a modularized top-level environment:
98+
99+
sage: from sage.all__sagemath_schemes import *
100+
75101
## Documentation
76102

77103
complete module documentation: https://archimede-institut.github.io/sage-euler-product/

0 commit comments

Comments
 (0)