docs: how-to guide for pulling cell metadata from a lab database (BatBase) (#1023) - #1108
Merged
Merged
Conversation
…Base) (#1023) Persona: scientist whose mass/area/nom_cap live in BatBase, not in the cycler file. Covers installing cellpy-connectors, storing credentials (keyring / env), fetch_meta key kinds, refresh_after, external_links, the BatBase -> cellpy field and unit map, and symptom-indexed troubleshooting. Wired into guides/index.md, how_do_i.md, llms.txt and zensical.toml navigation. Co-authored-by: Cursor <cursoragent@cursor.com>
This was referenced Sep 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Iteration 11 of #1023.
Persona / trigger: battery scientist whose mass, area, nominal capacity and cell type live in BatBase, not in the cycler file; has just heard
fetch_metaexists (#784 / cellpy-connectors#9) and finds nothing in the user docs.Added:
docs/guides/metadata_sources.md— what you get, install the connector, store credentials once (cellpy connectors configure batbase, env fallback,check), the four key kinds,refresh_after,external_linksprovenance, BatBase → cellpy field/unit map, symptom-indexed troubleshooting, batch outlook (#1107), pointer to the API reference for plugin authors.Wired:
zensical.tomlnav,guides/index.md,how_do_i.md("…get mass, area and nominal capacity from our lab database?"),docs/llms.txt, HISTORY.Verified against code: every snippet was run against the local BatBase dev server earlier today (round-trip in cellpy-connectors#9 / ife-bat/batbase#475); error/warning wording checked against
metadata_sources/registry.py. Found and fixed one adapter wrinkle on the way (cellpy-connectors#10:cycle_mode="full"→full_cell).Build:
uvx --with mkdocstrings-python zensical build --clean→ "No issues found";check_docs_relative_links.pyandcheck_rtd_latest_links.pypass.Made with Cursor