From 2c1dff70e1c493594b4553e84eabafd92b0c482e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 17 Jun 2026 06:16:33 +0000 Subject: [PATCH 1/2] Initial plan From 605d0d7dd337dea5d994509c9a0d127aa10f0887 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 17 Jun 2026 06:20:20 +0000 Subject: [PATCH 2/2] Add release-readiness docs and metadata polish for v0.1.0 --- CHANGELOG.md | 15 +++++++++++++++ CITATION.cff | 3 ++- README.md | 7 +++++-- pyproject.toml | 17 +++++++++++++++++ 4 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..bfe7465 --- /dev/null +++ b/CHANGELOG.md @@ -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. + diff --git a/CITATION.cff b/CITATION.cff index 34c2db8..22d737c 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -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: diff --git a/README.md b/README.md index 0dbb632..fa82608 100644 --- a/README.md +++ b/README.md @@ -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(Δ)) @@ -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} } ``` diff --git a/pyproject.toml b/pyproject.toml index 8521c24..1067349 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]