Skip to content

Real Libraries docs - #78

Merged
saidctb merged 5 commits into
mainfrom
prima-example-docs
Sep 28, 2026
Merged

saidctb merged 5 commits into
mainfrom
prima-example-docs

Conversation

@saidctb

@saidctb saidctb commented Sep 28, 2026

Copy link
Copy Markdown
Contributor

No description provided.

saidctb and others added 5 commits September 28, 2026 12:41
Lead with what the example does, the five solvers, a two-command quick start,
and the key files; explain the build with a diagram before the full script;
and show COBYLA, the progress callback stopping early, and the optional f/nf
outputs. Every snippet was run against a fresh build.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Say that prik_prima imports in the same shell after the quick start, name
when the static-archive pattern applies, point to the generated contracts
after the build steps, and give the COBYLA example a real constraint
(x[1] >= -1, minimum (1, -1)) using PRIMA's constraint <= 0 convention.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Add a three-step "How this works" overview after the opening example, say
early that prik_mpi.py is deliberately minimal (MPI_INT only, no receive
status), state that PRIK needs Open MPI's source and build trees and move
building Open MPI to the end, and show the key allreduce edit and a Comm
excerpt inline with the full contract and module in collapsible sections.
Every displayed file is still checked against its fixture.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@saidctb
saidctb merged commit e44d35c into main Sep 28, 2026
4 checks passed
@saidctb
saidctb deleted the prima-example-docs branch September 28, 2026 12:41
@codecov

codecov Bot commented Sep 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant