Skip to content

ACSVMath/sage_acsv

Repository files navigation

sage_acsv

This repository hosts the implementation of a SageMath package containing algorithms for analytic combinatorics in several variables.

The package works with any reasonably recent version of SageMath, we recommend to have SageMath 9.4 (released in August 2021) or newer.

Quickstart

The easiest way to install the latest released version of the package is via PyPI simply by running

sage -pip install sage-acsv

The package can be run in an interactive environment in the browser using Binder.

An article serving as an introduction to version 0.1.0 of the package and its internals can be found on the arXiv.

Installation from source

To install the package from the source code, either clone the git repository and run the command

sage -pip install .

from the root directory, i.e., the directory containing the pyproject.toml file.

For development, use sage -pip install -e . for an editable installation.

Alternatively, to install the latest version of the main branch directly from the GitHub repository, run

sage -pip install git+https://github.com/ACSVMath/sage_acsv.git

Running package tests

The doctests that are added in the package can be run by executing

sage -t sage_acsv

from the root of the cloned repository. The tests are run automatically on every push and for any PR to the main branch, and compatibility with several different SageMath releases (see recent workflows to see all tested versions) is checked.