docs: user-facing parameter table, gotchas, and API reference - #12
Open
reneotten wants to merge 1 commit into
Open
docs: user-facing parameter table, gotchas, and API reference#12reneotten wants to merge 1 commit into
reneotten wants to merge 1 commit into
Conversation
- Adds a requirements-and-gotchas section: Python ≥3.9, Rust ≥1.70, pip install -e rebuilds the extension (harmless but not a no-op), and the venv is not relocatable. - Replaces the inline physics-path comment with a markdown link to docs/PHYSICS.md and a "Start here" hint. - Adds a complete Device parameters table (keyword, unit, default, meaning) generated from the DeviceParams field list and defaults, including m_eff and clarifying its asymmetry. - Explains geo: only 1 and 2 are documented in PHYSICS.md; GAA is a qualitative proxy, not a quantitative nanowire model. - Adds a Python API table with signatures, returns, and notes — covering Device(**params), calc_potential, solve_self_consistent, calc_current, setters, psi_f, rho (C/m³), positions_nm, local_density_of_states (eta/d_e), sweeps, IVCurve, and M_E. - Includes a minimal session showing how to call the public API.
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
2 participants
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.
docs: user-facing parameter table, gotchas, and API reference
Adds a requirements-and-gotchas section: Python ≥3.9, Rust ≥1.70,
pip install -e rebuilds the extension (harmless but not a no-op),
and the venv is not relocatable.
Replaces the inline physics-path comment with a markdown link to
docs/PHYSICS.md and a "Start here" hint.
Adds a complete Device parameters table (keyword, unit, default,
meaning) generated from the DeviceParams field list and defaults,
including m_eff and clarifying its asymmetry.
Explains geo: only 1 and 2 are documented in PHYSICS.md; GAA is a
qualitative proxy, not a quantitative nanowire model.
Adds a Python API table with signatures, returns, and notes —
covering Device(**params), calc_potential, solve_self_consistent,
calc_current, setters, psi_f, rho (C/m³), positions_nm,
local_density_of_states (eta/d_e), sweeps, IVCurve, and M_E.
Includes a minimal session showing how to call the public API.