Skip to content

Commit 75a3696

Browse files
docs: add component READMEs to all sublibraries missing one
Add lib/<Name>/README.md to the 26 sublibraries that lacked one, using the canonical OrdinaryDiffEq.jl sublibrary README template: the standard SciML badge block (Zulip, Global Docs, ColPrac, SciML Code Style) plus the "component package of Optimization.jl in the SciML ecosystem" wording with a one-line description of each package's role. SimpleOptimization already had a README and is left unchanged. Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com> Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent c0f1326 commit 75a3696

26 files changed

Lines changed: 234 additions & 0 deletions

File tree

lib/OptimizationAuglag/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationAuglag.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationAuglag.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds an augmented Lagrangian method for solving constrained optimization problems.

lib/OptimizationBBO/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationBBO.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationBBO.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the BlackBoxOptim.jl global derivative-free optimizers.

lib/OptimizationBase/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationBase.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationBase.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the core interface, problem definitions, and automatic differentiation handling shared by the Optimization.jl ecosystem.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationCMAEvolutionStrategy.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationCMAEvolutionStrategy.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the CMAEvolutionStrategy.jl covariance matrix adaptation evolution strategy optimizers.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationEvolutionary.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationEvolutionary.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the Evolutionary.jl genetic and evolutionary algorithm optimizers.

lib/OptimizationGCMAES/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationGCMAES.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationGCMAES.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the GCMAES.jl gradient-based covariance matrix adaptation evolution strategy optimizer.

lib/OptimizationIpopt/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationIpopt.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationIpopt.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the Ipopt nonlinear interior-point optimizer.

lib/OptimizationLBFGSB/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationLBFGSB.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationLBFGSB.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the L-BFGS-B box-constrained quasi-Newton optimizer.

lib/OptimizationMOI/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationMOI.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationMOI.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for solvers exposed through the MathOptInterface.jl interface.

lib/OptimizationMadNLP/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OptimizationMadNLP.jl
2+
3+
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
4+
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/Optimization/stable/)
5+
6+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
7+
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
8+
9+
OptimizationMadNLP.jl is a component package of [Optimization.jl](https://github.com/SciML/Optimization.jl) in the SciML ecosystem. While completely independent and usable on its own, users interested in the full functionality should install and use [Optimization.jl](https://github.com/SciML/Optimization.jl); this package holds the wrapper for the MadNLP.jl nonlinear interior-point optimizer.

0 commit comments

Comments
 (0)