Welcome to RoughPy’s documentation!

Useful links: Source Repository | Issue Tracker |

RoughPy is a package for working with streaming data as rough paths, and working with algebraic objects such as free tensors, shuffle tensors, and elements of the free Lie algebra.

This library is currently in an alpha stage, and as such many features are still incomplete or not fully implemented. Please bear this in mind when looking at the source code.

Getting started

New to RoughPy? Check out the Absolute Beginner’s Guide. It contains an introduction to RoughPy’s main concepts and links to additional tutorials.

User guide

The user guide provides in-depth information on the key concepts of RoughPy with useful background information and explanation.

API reference

The reference guide contains a detailed description of the functions, modules, and objects included in RoughPy. The reference describes how the methods work and which parameters can be used. It assumes that you have an understanding of the key concepts.

Contributor’s guide

Want to add to the codebase? Can help add translation or a flowchart to the documentation? The contributing guidelines will guide you through the process of improving RoughPy.