Skip to content

1519 memilio-simulation PyPI package#1495

Open
annawendler wants to merge 74 commits intomainfrom
memilio-simulations-pypi-package
Open

1519 memilio-simulation PyPI package#1495
annawendler wants to merge 74 commits intomainfrom
memilio-simulations-pypi-package

Conversation

@annawendler
Copy link
Copy Markdown
Member

@annawendler annawendler commented Feb 23, 2026 •
edited
Loading

Changes and Information

Please briefly list the changes (main added features, changed items, or corrected bugs) made:

  • Adapt structureof memilio-simulation for PyPI
  • Add workflow that builds source distribution and wheels for both Linux and Windows and automatically uploads to PyPI on release with dynamic versioning

Merge Request - Guideline Checklist

Please check our git workflow. Use the draft feature if the Pull Request is not yet ready to review.

Checks by code author

  • Every addressed issue is linked (use the "Closes #ISSUE" keyword below)
  • New code adheres to coding guidelines
  • No large data files have been added (files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • Tests are added for new functionality and a local test run was successful (with and without OpenMP)
  • Appropriate documentation within the code (Doxygen) for new functionality has been added in the code
  • Appropriate external documentation (ReadTheDocs) for new functionality has been added to the online documentation
  • Proper attention to licenses, especially no new third-party software with conflicting license has been added
  • (For ABM development) Checked benchmark results and ran and posted a local test above from before and after development to ensure performance is monitored.

Checks by code reviewer(s)

  • Corresponding issue(s) is/are linked and addressed
  • Code is clean of development artifacts (no deactivated or commented code lines, no debugging printouts, etc.)
  • Appropriate unit tests have been added, CI passes, code coverage and performance is acceptable (did not decrease)
  • No large data files added in the whole history of commits(files should in sum not exceed 100 KB, avoid PDFs, Word docs, etc.)
  • On merge, add 2-5 lines with the changes (main added features, changed items, or corrected bugs) to the merge-commit-message. This can be taken from the briefly-list-the-changes above (best case) or the separate commit messages (worst case).

@annawendler
Copy link
Copy Markdown
Member Author

annawendler commented Feb 27, 2026 •
edited
Loading

The memilio-simulation package has been uploaded to TestPyPI https://test.pypi.org/project/memilio-simulation/ and can be installed via
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ memilio-simulation
This uses the test instance of PyPI for the memilio-simulation package and the normal PyPI instance for dependencies.

@annawendler annawendler changed the title memilio-simulation PyPI package 1519 memilio-simulation PyPI package Apr 10, 2026
@annawendler
Copy link
Copy Markdown
Member Author

annawendler commented Apr 10, 2026 •
edited
Loading

Before merging this PR, I would suggest to upload a first version of the memilio-simulation package to PyPI using this PR. For this, we need to do the following:

  • Someone has to register at PyPI and enable Trusted Publishing (https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/).
  • In pypi.yml and pyproject.toml: Uncomment line 5 instead of line 3, respectively, so that the workflow is executed in this PR and set the version to the last release tag of MEmilio. This way we can test that trusted publishing works.
  • Delete lines 4 and 5 in pypi.yml and pyproject.toml before merging this PR so that the pypi.yml workflow is executed on every release.

@annawendler annawendler requested a review from HenrZu April 13, 2026 10:49
HenrZu
HenrZu requested changes Apr 14, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@HenrZu HenrZu left a comment

Choose a reason for hiding this comment

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

Thank you for this addition. This is really great and makes Memilio much more accessible.

Once everything is done from the technical side, we need to extend the documentation as this would heavily simplify the installation process of the simulation package.
(espcecially, which systems are now supported)

Comment thread .github/workflows/pypi.yml Outdated
Comment on lines +4 to +5
# remove following line before merge:
# on: [pull_request, release]
Copy link
Copy Markdown
Contributor

@HenrZu HenrZu Apr 14, 2026

Choose a reason for hiding this comment

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

remove later

Comment thread .github/workflows/pypi.yml Outdated
Comment thread pyproject.toml
Comment on lines +4 to +5
# remove following line before merge:
# version = "2.3.0"
Copy link
Copy Markdown
Contributor

@HenrZu HenrZu Apr 14, 2026

Choose a reason for hiding this comment

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

rm later

Comment thread .github/workflows/pypi.yml Outdated
Comment thread .github/workflows/pypi.yml
Comment thread .github/workflows/pypi.yml Outdated
Comment thread .github/workflows/pypi.yml Outdated
@annawendler
Copy link
Copy Markdown
Member Author

annawendler commented Apr 15, 2026

This is the current version of the TestPyPI page with the latest changes: https://test.pypi.org/project/memilio-simulation/2.3.1.dev87/

@annawendler annawendler requested a review from HenrZu April 15, 2026 11:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@HenrZu HenrZu Awaiting requested review from HenrZu

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

memilio-simulation PyPI package

2 participants

@annawendler @HenrZu