Skip to content

Commit

Permalink
README.rst: Document passagemath install method
Browse files Browse the repository at this point in the history
  • Loading branch information
mkoeppe committed Dec 23, 2024
1 parent 9a63206 commit eb06d86
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,33 @@ D. Run in a standalone installation of the SageMath distribution (no conda)
import cutgeneratingfunctionology.igp as igp; from cutgeneratingfunctionology.igp import *

- Follow the instructions and examples in https://github.com/mkoeppe/cutgeneratingfunctionology/blob/master/demo.rst or https://github.com/mkoeppe/cutgeneratingfunctionology/blob/master/demo.ipynb .


E. Run in Python (no installation of SageMath required)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This method uses the modularized distributions from https://github.com/passagemath

- Clone the GitHub repository https://github.com/mkoeppe/cutgeneratingfunctionology.git::

git clone https://github.com/mkoeppe/cutgeneratingfunctionology.git
cd cutgeneratingfunctionology

- (Optional:) Create a virtual environment

python3 -m venv venv-cgf
. venv-cgf/bin/activate

- Install the cutgeneratingfunctionology package using pip::

pip install ".[passagemath]"

- Start Python::

python3

- At the Python prompt, type::

import cutgeneratingfunctionology.igp as igp; from cutgeneratingfunctionology.igp import *

- Follow the instructions and examples in https://github.com/mkoeppe/cutgeneratingfunctionology/blob/master/demo.rst or https://github.com/mkoeppe/cutgeneratingfunctionology/blob/master/demo.ipynb .

0 comments on commit eb06d86

Please sign in to comment.