Ask Your Question

Implementing a new class on Sage

asked 2024-02-29 23:16:51 +0200

alvarolmartinez gravatar image

I have developed a related to my PhD thesis that I believe could be a valuable addition to Sage, particularly for researchers in link homology. I have been reading the documentation and the contributing to Sage pages, but I'm unsure if I'm doing things right and I would like to check.

My work includes:

  1. A 'Foam' class, an extension of SimplicialComplex with additional data and methods.
  2. An algorithm to count colorings of a Foam by converting it into an Integer Linear Programming problem.
  3. A module for (gln-) foam evaluation (see arXiv:1702.04140)

I forked the Sage repository's develop branch and created a 'foams' directory in sage/src. Should I simply develop my methods in the foams directory and submit a pull request, or is there a ticket system I should be aware of? Am I supposed to start a stream on zulip?

Thank you for your time!

edit retag flag offensive close merge delete



This question is better suited for sage-devel group.

Max Alekseyev gravatar imageMax Alekseyev ( 2024-03-01 13:10:03 +0200 )edit

Thank you!

alvarolmartinez gravatar imagealvarolmartinez ( 2024-03-01 14:54:06 +0200 )edit

1 Answer

Sort by » oldest newest most voted

answered 2024-03-01 19:31:21 +0200

First, from the point of view of the Sage library: the directories in SAGE_ROOT/src/sage are mostly pretty broad — groups, graphs, rings, etc. — and it sounds to me like foams is too narrow. If it is an extension of SimplicialComplex, the files could go in src/sage/topology or in a subdirectory of this, or conceivably in a subdirectory of some other main directory.

Second, you can certainly submit a pull request, but it's probably also a good idea to post to the sage-devel Google group to alert people that you've done this, to advertise your work, and to ask for feedback and reviews. No need to start a stream on zulip.

edit flag offensive delete link more


That makes sense! Thank you

alvarolmartinez gravatar imagealvarolmartinez ( 2024-03-01 20:20:00 +0200 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

1 follower


Asked: 2024-02-29 23:16:51 +0200

Seen: 224 times

Last updated: Mar 01