Skip to content

Release-readiness polish for v0.1.0 and Zenodo prep #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
beanapologist merged 2 commits into from
Jun 17, 2026
Merged

Release-readiness polish for v0.1.0 and Zenodo prep #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c1dff7
Initial plan
Copilot Jun 17, 2026
605d0d7
Add release-readiness docs and metadata polish for v0.1.0
Copilot Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Changelog

All notable changes to this project are documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2026-06-17

### Added
- Initial public release of Jump-Diffusion-Engine.
- Core simulation and stochastic stability analysis methods in `engine.py`.
- Automated test suite and CI workflow for Python 3.9–3.12.
- Packaging metadata for setuptools-based builds.

3 changes: 2 additions & 1 deletion CITATION.cff
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
cff-version: 1.2.0
message: "If you use this software, please cite it as below."
message: "If you use this software, please cite it as below. DOI metadata will be added after the first Zenodo-backed release."
title: "Jump Diffusion Engine"
version: "0.1.0"
date-released: 2026-06-17
abstract: "A universal framework for multistable stochastic control."
type: software
authors:
Expand Down
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Jump-Diffusion-Engine – Stochastic Stability Analysis
[![CI](https://github.com/beanapologist/Jump-Diffusion-Engine/actions/workflows/ci.yml/badge.svg)](https://github.com/beanapologist/Jump-Diffusion-Engine/actions/workflows/ci.yml)
[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
[![GitHub release](https://img.shields.io/github/v/release/beanapologist/Jump-Diffusion-Engine)](https://github.com/beanapologist/Jump-Diffusion-Engine/releases)

**Simulate, analyse, and steer noisy nonlinear systems.**

A simulation framework for systems with a Source (Λ(t)), a Medium (Δ), and a nonlinear Sink (f(Δ))
Expand Down Expand Up @@ -171,8 +175,7 @@ When training a robot to walk, you do not want it to explore so far that it brea
year = {2026},
publisher = {GitHub},
url = {https://github.com/beanapologist/Jump-Diffusion-Engine},
note = {Versioned releases archived on Zenodo},
doi = {10.5281/zenodo.XXXXXXX}
note = {Versioned releases archived on Zenodo; DOI will be added after the first Zenodo-backed release}
}
```

Expand Down
17 changes: 17 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,29 @@ readme = "README.md"
requires-python = ">=3.9"
license = "Apache-2.0"
authors = [{ name = "Sarah Marin" }]
classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Science/Research",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Topic :: Scientific/Engineering :: Mathematics",
]
dependencies = [
"numpy>=1.23,<3.0",
"scipy>=1.10,<2.0",
"matplotlib>=3.7,<4.0",
]

[project.urls]
Homepage = "https://github.com/beanapologist/Jump-Diffusion-Engine"
Repository = "https://github.com/beanapologist/Jump-Diffusion-Engine"
Issues = "https://github.com/beanapologist/Jump-Diffusion-Engine/issues"
Changelog = "https://github.com/beanapologist/Jump-Diffusion-Engine/blob/main/CHANGELOG.md"

[project.optional-dependencies]
dev = ["pytest>=7.0"]

Expand Down
Loading