Developer’s guide

surface-dynamics is a Python/Cython package that depends on SageMath. We try to follow the programming conventions of SageMath.

Contributions to surface-dynamics are always welcome. If you want to contribute, don’t hesitate to reach out to us, create an issue, or contribute a pull request.

We recommend to work on surface-dynamics with a pixi environment which guarantees that you are using dependencies that are known to work.

Once you installed pixi, you can enter a shell with your version of surface-dynamics installed by typing:

pixi shell -e dev

You can then start SageMath normally, by typing sage.

You can also run SageMath directly with:

pixi run sage

To run the test suite, you can use sage -tp surface_dynamics and pytest directly or just run:

pixi run -e dev test-doctest
pixi run -e dev doctest-long  # to run the tests with the --long flag
pixi run -e dev test-pytest

Or to just run all tests and doctests:

pixi run test

To check your code for style errors:

pixi run lint

And to preview the documentation:

pixi run doc

This should cover the very basics of development but there are certainly lots of things that we missed here, so don’t hesitate to contact us if anything does not work out right away :)