Overview#
graphlow is a differentiable mesh-graph library built around one core
idea: geometry and topology should be available through a single mesh object
while still working with autograd-friendly tensor backends.
What contributors usually touch#
Depending on the change, you will usually work in one or more of these areas:
src/graphlow/corefor the mesh container, topology wrapper, and geometry wrappersrc/graphlow/geometryfor coordinate-dependent computationssrc/graphlow/graphfor sparse topology builders and mapping operatorstestsfor unit and end-to-end coveragedocs/sourceandexamplesfor Sphinx documentation and gallery content
Contributor workflow in practice#
For most changes, the shortest reliable loop is:
set up the development environment with
uvmake the code change
run the relevant tests
run lint checks
rebuild the Sphinx docs if you touched public APIs, examples, or docs
Read this guide in that same order:
What this guide does not invent#
This guide intentionally focuses on what is already defined in the repository. It does not guess a pull request template, branching model, or release process that has not been documented yet.