Skip to content

Add load_biomodel() and list_biomodels() for VCell server integration#36

Merged
jcschaff merged 4 commits intomainfrom
fine-tuning
Mar 19, 2026
Merged

Add load_biomodel() and list_biomodels() for VCell server integration#36
jcschaff merged 4 commits intomainfrom
fine-tuning

Conversation

@jcschaff
Copy link
Copy Markdown
Member

Summary

  • Add vc.load_biomodel() to fetch and parse models from the VCell server by database ID, name, or owner
  • Add vc.list_biomodels() to return all accessible models (public, shared, private) as a list of dicts
  • Add CLAUDE.md with project conventions and verification steps
  • Update quickstart guide with authenticated workflow examples and docs link in README
  • Fix docs homepage links (remove unsupported grid cards div)
  • Fix installation page ("optional dependencies" → "included visualization libraries")

Details

load_biomodel() supports three usage patterns:

Public model by ID (no auth needed)

bm = vc.load_biomodel("279851639")

Search by name (requires auth)

bm = vc.load_biomodel(name="Tutorial_MultiApp", owner="tutorial", api_client=client)

List all accessible models (requires auth)

models = vc.list_biomodels(api_client=client)

Test plan

  • Unit tests for load_biomodel by ID (with default and explicit client)
  • All 66 existing tests pass
  • make check passes (ruff, mypy, deptry)
  • Manual verification of list_biomodels and name search with authenticated client

jcschaff and others added 3 commits March 19, 2026 07:56
Implements load_biomodel(biomodel_id, api_client=None) which uses the
VCell REST API to fetch and parse a BioModel. Public models work with
the default anonymous client; private models accept an authenticated
ApiClient. Replaces the old load_vcml_biomodel_id() URL-based approach.

Also adds CLAUDE.md with project conventions and verification steps.
Add vc.list_biomodels() to return all accessible models as a list of
dicts with id, name, and owner. Extend load_biomodel() to accept name
and owner kwargs for searching by name. Both require an authenticated
ApiClient. Update quickstart guide with authenticated workflow examples.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jcschaff jcschaff self-assigned this Mar 19, 2026
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jcschaff jcschaff merged commit 8795b69 into main Mar 19, 2026
6 checks passed
@jcschaff jcschaff deleted the fine-tuning branch March 25, 2026 19:46
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