Repository navigation
Docs: TOML-first usage, input reference, automatic figure, choosing nu and Nn - #65
Open
rogeriojorge wants to merge 7 commits into
Open
rogeriojorge wants to merge 7 commits into
rogeriojorge wants to merge 7 commits into
Conversation
rogeriojorge
added a commit
that referenced
this pull request
Oct 7, 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
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.
Stacked on #64.
UsageandInput File Formatare rewritten around the one-file workflow,spectrax input.tomlor a three-line Python script. The input reference is a complete commented species TOML, checked to parse, with units stated once. It replaces the old table of internal keys (dn1,nx, ...) that only the default case used.nuandNn: a short guide on how to read the Hermite-spectrum panel. It also states that, for ion waves with hot electrons, the sink also supplies electron Landau damping, and thatnuof order 1 ω_pe with 128 or more Hermite modes reproduces exact kinetic growth rates. This was measured for the three-population ion-acoustic benchmark.Documentation only. No code changes.