Skip to content

Make suntools an installable library#883

Open
balos1 wants to merge 14 commits intodevelopfrom
feature/suntools-library
Open

Make suntools an installable library#883
balos1 wants to merge 14 commits intodevelopfrom
feature/suntools-library

Conversation

@balos1
Copy link
Copy Markdown
Member

@balos1 balos1 commented Mar 20, 2026

No description provided.

@balos1 balos1 added this to the SUNDIALS v7.8.0 milestone Mar 20, 2026
@balos1 balos1 changed the title Make suntools a installable library Make suntools an installable library Mar 20, 2026
@balos1 balos1 marked this pull request as ready for review April 3, 2026 05:19
drreynolds
drreynolds previously approved these changes Apr 6, 2026
Copy link
Copy Markdown
Collaborator

@drreynolds drreynolds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, aside from my question regarding naming.

Comment thread suntools/README.md
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not knowledgeable about setting up Python libraries, but by its name, the tools/pyproject.toml file seems to call itself tools, but the contents of that file refer to itself as both sundials-suntools (project->name) and as suntools (tool.setuptools->packages). This file then refers to it both as tools and suntools.

#. How consistent should these names be?
#. If this is only installed alongside the SUNDIALS source code then I imagine tools is sufficiently descriptive, but if this were available directly using pip then I'd think a more descriptive name would be helpful.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing out the inconsistency. I have updated both the naming and structure to make suntools more of a standalone module.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we keep the tools directory? I think the original intent was we could eventually add other, non-python, tools here as well (like those in the analysis-utilities repo).

Maybe this structure would work:

sundials/
+-- tools/
|   +-- suntools/
|       +-- pyproject.toml
|       +-- README.md
|       +-- examples/
|       `-- src/

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think those could go under scripts or be folded into a submodule of suntools if they are python.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we foresee having non-python tools? In which case it might be nice to keep all tools grouped under a tools directory and all python-based tools go into tools/suntools

drreynolds
drreynolds previously approved these changes Apr 13, 2026
@balos1 balos1 added the ai-assisted This pull request includes code written with the assistance from AI label Apr 14, 2026
@drreynolds
Copy link
Copy Markdown
Collaborator

This seems to be failing the CI; once it passes I'll "approve"

@gardner48
Copy link
Copy Markdown
Member

Looks like the tarscript in the Jenkins CI is failing because of the directory changes

@balos1 balos1 requested a review from drreynolds April 19, 2026 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-assisted This pull request includes code written with the assistance from AI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants