Add Quick MATLAB Example section to quick_start.rst - #136
Open
djkees wants to merge 1 commit into
Open
Conversation
Mirrors the existing Quick Python Example: a copy/paste, hand-held walkthrough (install Python, install cea, pyenv setup, run an eq_solve call) aimed at MATLAB users with no Python background. (cherry picked from commit 476b6d2)
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.
Summary
Adds a "Quick MATLAB Example" section to
docs/source/quick_start.rst, mirroring the existing "Quick Python Example" section for MATLAB users.djkees#161
Changes
docs/source/quick_start.rst: new "Quick MATLAB Example" section, split into "One-Time Setup" (installing Python, installingceaviapython -m pip install cea, finding the Python path) and "Every MATLAB Session" (pyenv+ importingcea/cea.matlab), followed by a "Solving a Problem" walkthrough that runscea.matlab.eq_solveon the same stoichiometric H2/O2 HP combustion case as the Python example.pip install cea) rather than building from source, since that avoids needing a compiler/CMake/conda entirely for MATLAB users who just want to callceafrom MATLAB.pyenvPython-version compatibility (MATLAB only supports a limited range of Python versions per release), linking to MathWorks' compatibility table.Testing
ceainstall, confirming each step and command as written.eq_solvecall's numeric result (Adiabatic flame temperature: 3074.5 K) was independently cross-checked against the existing Python quickstart's ownEqSolver/Mixturelow-level API for the same H2/O2 inputs, which produced the identical 3074.5 K.Compatibility / Numerical behavior
Drafted with Claude's assistance