Prepare single-file module for initial release#6
Merged
Conversation
- Update Installation section with end-user GitHub release install command, keep editable install for contributors, note PyPI not yet configured - Move bibtex citation block into its own Citation section (was embedded after the last Use Cases item) - Update citation note to reference v0.1.0 as the initial release
Copilot
AI
changed the title
[WIP] Update README for initial release readiness
Prepare single-file module for initial release
Jun 17, 2026
beanapologist
left a comment
beanapologist
left a comment
Owner
There was a problem hiding this comment.
can rename engine.py to jump_diffusion_engine.py?
beanapologist
requested changes
Jun 17, 2026
beanapologist
left a comment
beanapologist
left a comment
Owner
There was a problem hiding this comment.
can rename engine.py to jump_diffusion_engine.py?
Update all references across tests, CI workflow, README, CHANGELOG, and pyproject.toml to use the new module name.
Contributor
Author
Done in the latest commit. |
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
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.
README install instructions were contributor-only (
pip install -e .) with no end-user path, and the BibTeX citation block was embedded inline after the last use-case entry with no heading. The main module has also been renamed fromengine.pytojump_diffusion_engine.pyfor clarity.Changes
Installation section
pip install "jump-diffusion-engine @ https://github.com/beanapologist/Jump-Diffusion-Engine/archive/refs/tags/v0.1.0.tar.gz"Citation section
## Citationsection before## Licensenotefield:Version 0.1.0 – initial release; Zenodo archiving pendingModule rename:
engine.py→jump_diffusion_engine.pyjump_diffusion_engine.pypyproject.toml:py-modules = ["jump_diffusion_engine"]tests/test_engine.py: import updated tofrom jump_diffusion_engine import JumpDiffusionEngine.github/workflows/ci.yml: import smoke-test usesjump_diffusion_enginefrom engine importreferences inREADME.mdand filename references inCHANGELOG.md