Skip to content

Add API.md with full API reference and Mermaid diagrams#1

Open
Copilot wants to merge 2 commits into
cleanup/uv-modernizefrom
copilot/add-api-documentation-with-mermaid
Open

Add API.md with full API reference and Mermaid diagrams#1
Copilot wants to merge 2 commits into
cleanup/uv-modernizefrom
copilot/add-api-documentation-with-mermaid

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 25, 2026

No structured API reference existed — only a README and Jupyter notebooks. This adds API.md as a dedicated, scannable API doc.

Contents

  • 5 Mermaid diagrams

    • graph TD — package/module structure
    • flowchart LR — typical fit workflow (load → choose model → fit → visualise → export)
    • classDiagram — model taxonomy (NoYieldStress / YieldStress / Composite)
    • sequenceDiagrammake_par_widget branching logic (pre-fit vs defaults)
    • graph LR — runtime dependency map
  • Model reference for all 15 models: LaTeX equation, parameter table (name, default, min, max, unit)

  • Function reference for all public callables across rheofit.models, rheofit.rheodata, and rheofit.visualization, with signatures, parameter tables, and short usage snippets

Quick example (from the doc)

import rheofit.rheodata as rheodata
from rheofit.models import HB_model, fit_FC, show_parameter_table
from rheofit.visualization import plot_fit_res

exp = rheodata.cp2pc_pg
data = exp.datasets[0].data

result = fit_FC(HB_model, data)
show_parameter_table(result)
fig = plot_fit_res(result, show_par_values=True)

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add API documentation using mermaid diagrams Add API.md with full API reference and Mermaid diagrams Mar 25, 2026
@caggionim caggionim marked this pull request as ready for review March 25, 2026 16:59
Copilot AI requested a review from caggionim March 25, 2026 16:59
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.

2 participants