Document supported features - #11
Draft
smartalecH wants to merge 1 commit into
Draft
Conversation
Adds a running Julia-vs-Python feature list, compiled from the current sources, covering the filters, SSP1/SSP2 projections, dilation/erosion, lengthscale constraints, AD support, and the low-level Julia API, plus known limitations and gaps. Also links the new page from the top-level and Julia READMEs and adds Julia installation instructions to the top-level README.
This was referenced Aug 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #9.
Adds
docs/features.md: a running list of what the Julia and Python packages each support, compiled by reading the current sources (src/julia/SSP/src/*.jl, the ChainRulesCore extension, andsrc/python/ssp_topopt/*.py) rather than from memory.The page has three parts:
Notable asymmetries it records:
ssp1), dilation/erosion (dilation_distance), minimum-lengthscale constraints (constraint_solid/constraint_void), and the low-levelinit/solve!/adjoint_solve!API.get_conic_radius_from_eta_e, a publictanh_projection, andperiodic_axesinconic_filter.dx == dy. Julia's routines are written generically over dimension, but only 2D is covered by tests and examples, so the table says that rather than claiming 3D support.Also links the new page from the top-level and Julia READMEs, and adds Julia installation instructions to the top-level README (it previously only covered
pip).@lxvm could you sanity-check the Julia column before this comes out of draft?