Skip to content

Move build files into pycode/memilio-simulation and update actions#1566

Merged
reneSchm merged 18 commits into
mainfrom
1565-move-installation-files-for-memilio-simulation-into-pycodememilio-simulation
Jun 11, 2026
Merged

Move build files into pycode/memilio-simulation and update actions#1566
reneSchm merged 18 commits into
mainfrom
1565-move-installation-files-for-memilio-simulation-into-pycodememilio-simulation

Conversation

@reneSchm

@reneSchm reneSchm commented May 13, 2026

Copy link
Copy Markdown
Member

Changes and Information

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

  • Move pyproject.toml and CMakeLists.txt from project root (back) into pycode/memilio-simulation.
  • Add MacOS build to PyPI release.
  • Merge / move installation and download documentation to avoid repetition.
  • Minor improvements.

If need be, add additional information and what the reviewer should look out for in particular:

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 and checked in the preview.
  • 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).

@reneSchm reneSchm requested a review from annawendler May 13, 2026 12:26
@codecov

codecov Bot commented May 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.46%. Comparing base (1d8bbc2) to head (a98e473).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1566      +/-   ##
==========================================
- Coverage   97.47%   97.46%   -0.02%     
==========================================
  Files         190      190              
  Lines       15966    15966              
==========================================
- Hits        15563    15561       -2     
- Misses        403      405       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@reneSchm reneSchm linked an issue May 18, 2026 that may be closed by this pull request
2 tasks
@reneSchm

Copy link
Copy Markdown
Member Author

PyPI workflow without upload:
grafik

Comment thread docs/source/cpp/installation.rst Outdated
@reneSchm

Copy link
Copy Markdown
Member Author

I merged all duplicate install and download sections (unless I overlooked one) into one for each C++, Python, and general setup / cloning. I also fixed a lot of spurious warnings while fixing my own mistakes, so maybe ask for an additional proof-reader for the docs.

@annawendler annawendler left a comment

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.

Thank you for these changes, this makes the installation more consistent and intuitive again! My comments are only regarding documentation.

Comment thread .github/workflows/pypi.yml Outdated
Comment thread .github/workflows/pypi.yml Outdated
Comment thread .github/workflows/pypi.yml Outdated
Comment thread docs/source/cpp/installation.rst Outdated
Comment thread docs/source/cpp/installation.rst Outdated
Comment thread docs/source/python/python_packages.rst Outdated
Comment thread docs/source/python/python_packages.rst Outdated
Comment thread docs/source/python/python_packages.rst
Comment thread pycode/memilio-simulation/pyproject.toml Outdated
Comment thread pycode/memilio-simulation/pyproject.toml Outdated
Comment thread .github/workflows/pypi.yml Outdated
Comment thread .github/workflows/pypi.yml Outdated
reneSchm and others added 4 commits June 10, 2026 19:24
Co-authored-by: annawendler <106674756+annawendler@users.noreply.github.com>
Co-authored-by: reneSchm <49305466+reneSchm@users.noreply.github.com>
@reneSchm reneSchm requested a review from annawendler June 11, 2026 11:14

@annawendler annawendler left a comment

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.

I found one last typo but otherwise this looks good :D

Comment thread docs/source/cpp/installation.rst Outdated
Co-authored-by: annawendler <106674756+annawendler@users.noreply.github.com>
@reneSchm reneSchm requested a review from annawendler June 11, 2026 14:08
@reneSchm

Copy link
Copy Markdown
Member Author

Thanks for your thorough review. I did not expect there to be that many doc changes, but I think this should make the installation easier to navigate.

@reneSchm reneSchm merged commit c2c884c into main Jun 11, 2026
@reneSchm reneSchm deleted the 1565-move-installation-files-for-memilio-simulation-into-pycodememilio-simulation branch June 11, 2026 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move installation files for memilio-simulation into pycode/memilio-simulation

2 participants