From f44280edd7d7ffcc939f8a8e850319f441351c1e Mon Sep 17 00:00:00 2001 From: Melvin Alvarez Date: Mon, 16 Feb 2026 16:24:25 +0100 Subject: [PATCH] chore: prepare v1.0.0 release for crates.io and PyPI MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit BREAKING CHANGES: - Version bumped to 1.0.0 (stable release) - Default features: Removed python-bindings from default (fixes linking issues) - python-bindings now opt-in feature for PyO3 builds Metadata Updates: - Authors: HFThot Research Lab - Repository: https://github.com/ThotDjehuty/optimiz-r - Homepage: https://hfthot-lab.eu - Documentation: https://optimiz-r.readthedocs.io README Updates: - Version badge: 0.3.0 → 1.0.0 - What's New section updated for v1.0.0 stable release - Citation author updated - Contact information updated This prepares OptimizR for publication to: - crates.io (Rust package registry) - PyPI (Python package index) API is now stable and follows semantic versioning from v1.0.0 forward. --- Cargo.toml | 8 ++++---- README.md | 23 +++++++++++------------ pyproject.toml | 12 ++++++------ 3 files changed, 21 insertions(+), 22 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index e109b75..119ce06 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,11 +1,11 @@ [package] name = "optimizr" -version = "0.3.0" +version = "1.0.0" edition = "2021" -authors = ["Your Name "] +authors = ["HFThot Research Lab "] description = "High-performance optimization algorithms in Rust with Python bindings" license = "MIT" -repository = "https://github.com/yourusername/optimiz-r" +repository = "https://github.com/ThotDjehuty/optimiz-r" keywords = ["optimization", "machine-learning", "statistics", "numerical", "scientific"] categories = ["algorithms", "science", "mathematics"] readme = "README.md" @@ -28,7 +28,7 @@ ordered-float = "4.2" statrs = "0.17" [features] -default = ["python-bindings"] +default = [] python-bindings = ["pyo3", "numpy"] parallel = [] diff --git a/README.md b/README.md index d86313f..7891f75 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,20 @@ **High-performance optimization algorithms in Rust with Python bindings** -[![Version](https://img.shields.io/badge/version-0.3.0-blue.svg)](https://github.com/ThotDjehuty/optimiz-r/releases) +[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/ThotDjehuty/optimiz-r/releases) [![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE) [![Rust](https://img.shields.io/badge/rust-1.70+-orange.svg)](https://www.rust-lang.org/) [![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/) OptimizR provides blazingly fast, production-ready implementations of advanced optimization and statistical inference algorithms. Built with Rust for maximum performance and exposed to Python through PyO3, it delivers 50-100× speedup over pure Python implementations. -## ✨ What's New in v0.3.0 +## ✨ What's New in v1.0.0 -🎮 **Mean Field Games (MFG)** - Complete 1D solver for large population dynamics with HJB-Fokker-Planck coupling -📚 **Validated Tutorial Notebooks** - All 7 example notebooks tested and production-ready -🏗️ **Maturin Build System** - Reliable cross-platform builds (fixes macOS issues) -🐍 **Enhanced Python Wrappers** - Smart OOP interfaces with automatic Rust acceleration -📖 **Comprehensive Documentation** - New MFG tutorial with 3D visualizations and complete audit report - -[**→ See Full Release Notes**](RELEASE_NOTES_v0.3.0.md) +🎉 **Production Ready** - First stable release with comprehensive documentation +📚 **ReadTheDocs** - Full documentation at https://optimiz-r.readthedocs.io +🏗️ **Published to crates.io** - Install with `cargo add optimizr` +🐍 **Published to PyPI** - Install with `pip install optimizr` +🔒 **Stable API** - Semantic versioning from v1.0.0 forward ## Features @@ -567,9 +565,9 @@ If you use OptimizR in your research, please cite: ```bibtex @software{optimizr2024, title = {OptimizR: High-Performance Optimization Algorithms in Rust}, - author = {Your Name}, + author = {HFThot Research Lab}, year = {2024}, - version = {0.2.0}, + version = {1.0.0}, url = {https://github.com/ThotDjehuty/optimiz-r} } ``` @@ -592,7 +590,8 @@ Inspired by: - Issues: [GitHub Issues](https://github.com/ThotDjehuty/optimiz-r/issues) - Discussions: [GitHub Discussions](https://github.com/ThotDjehuty/optimiz-r/discussions) -- Email: your.email@example.com +- Website: [HFThot Research Lab](https://hfthot-lab.eu) +- Email: contact@hfthot-lab.eu --- diff --git a/pyproject.toml b/pyproject.toml index d85b305..dcc53bb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,10 +4,10 @@ build-backend = "maturin" [project] name = "optimizr" -version = "0.3.0" +version = "1.0.0" description = "High-performance optimization algorithms in Rust with Python bindings" authors = [ - {name = "Your Name", email = "your.email@example.com"} + {name = "HFThot Research Lab", email = "contact@hfthot-lab.eu"} ] readme = "README.md" license = {text = "MIT"} @@ -48,10 +48,10 @@ all = [ ] [project.urls] -Homepage = "https://github.com/yourusername/optimiz-r" -Documentation = "https://github.com/yourusername/optimiz-r/blob/main/README.md" -Repository = "https://github.com/yourusername/optimiz-r" -Issues = "https://github.com/yourusername/optimiz-r/issues" +Homepage = "https://hfthot-lab.eu" +Documentation = "https://optimiz-r.readthedocs.io" +Repository = "https://github.com/ThotDjehuty/optimiz-r" +Issues = "https://github.com/ThotDjehuty/optimiz-r/issues" [tool.maturin] python-source = "python"