MATLAB_OCTAVE now just Octave in docs. - #445
Open
jbrzensk wants to merge 1 commit into
Open
Conversation
…lab, as well as folder structure.
jbrzensk
added
Documentation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to consistently refer to the GNU Octave implementation as “Octave” (instead of “MATLAB/Octave” or “MATLAB/OCTAVE”), aligning with Issue #444’s goal of de-emphasizing MATLAB dependencies in user-facing docs.
Changes:
- Renames “MATLAB/Octave” wording to “Octave” across README, Sphinx pages, API index pages, and contributing/community docs.
- Updates example pages’ “implemented in” link labels to “Octave”.
- Adjusts various headings/labels in Sphinx docs to reflect the Octave-focused messaging.
Reviewed changes
Copilot reviewed 43 out of 43 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Rewords README to refer to Octave tests/examples instead of MATLAB/Octave. |
| doc/sphinx/source/overview.md | Updates overview feature card wording to “Octave”. |
| doc/sphinx/source/math_functions/CSRCReportOnMOLE.md | Rewords report references from MATLAB/Octave to Octave. |
| doc/sphinx/source/intros/gettingstarted.md | Renames “MATLAB/Octave” tab and link labels to “Octave”. |
| doc/sphinx/source/examples/Time-Integrators/RK4.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Time-Integrators/RK2.md | Changes MATLAB/OCTAVE link label to Octave; updates plotting wording. |
| doc/sphinx/source/examples/Time-Integrators/backward_euler.md | Changes MATLAB/Octave link label to Octave. |
| doc/sphinx/source/examples/Sturm-Liouville/Legendre.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Sturm-Liouville/Laguerre.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Sturm-Liouville/Hermite.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Sturm-Liouville/Helmholtz.md | Changes MATLAB/OCTAVE link labels to Octave; updates wording for variants. |
| doc/sphinx/source/examples/Sturm-Liouville/Chebyshev.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Sturm-Liouville/Bessel.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Parabolic/2D/Parabolic2D.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Parabolic/1D/Terzaghi1D.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Parabolic/1D/Parabolic1D.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Navier-Stokes/Lock-Exchange.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Navier-Stokes/Cylinder-Flow-2D.md | Renames MATLAB/Octave phrasing to Octave in narrative/results headings. |
| doc/sphinx/source/examples/Mixed/3D/Convection-Diffusion.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Integration/Integration1D.md | Rewords MATLAB references to Octave; updates “implemented in” label. |
| doc/sphinx/source/examples/index.md | Updates examples landing page to refer to Octave instead of OCTAVE/MATLAB. |
| doc/sphinx/source/examples/Hyperbolic/1D/Wave-1D.md | Changes MATLAB/OCTAVE link labels to Octave; updates variants label. |
| doc/sphinx/source/examples/Hyperbolic/1D/Hyperbolic1D.md | Changes MATLAB/OCTAVE link labels to Octave; updates variants label. |
| doc/sphinx/source/examples/Hyperbolic/1D/Burgers1D.md | Changes MATLAB/OCTAVE link label to Octave. |
| doc/sphinx/source/examples/Elliptic/2D/Elliptic2D-Nodal-Curv.md | Updates MATLAB/OCTAVE wording to Octave in explanatory text. |
| doc/sphinx/source/examples/Elliptic/2D/Elliptic2D-Nodal-Curv-Sinusoidal.md | Updates MATLAB/OCTAVE wording to Octave in explanatory text. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Periodic-BC.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Non-Periodic-BC.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Non-Homogeneous-Dirichlet.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Left-Robin-Right-Robin.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Left-Neumann-Right-Robin.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Left-Neumann-Right-Neumann.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Left-Neumann-Right-Dirichlet.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Left-Dirichlet-Right-Robin.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/examples/Elliptic/1D/Elliptic1D-Homogeneous-Dirichlet.md | Changes MATLAB/OCTAVE link label to Octave; updates variants label. |
| doc/sphinx/source/dev-notes/RELEASING.md | Updates release checklist wording to say Octave tests. |
| doc/sphinx/source/api/matlab_octave/matlab_index.rst | Renames MATLAB/Octave function index to Octave function index. |
| doc/sphinx/source/api/matlab_octave/index-beta.rst | Renames MATLAB/Octave API section wording to Octave; updates graph title/text. |
| doc/sphinx/source/api/matlab_octave/api.rst | Renames MATLAB/Octave API page to Octave API. |
| doc/sphinx/README.md | Updates docs README to refer to Octave API reference. |
| CONTRIBUTING.md | Updates contribution guide headings/wording to refer to Octave. |
| COMMUNITY_ROLES.md | Updates community roles wording to refer to Octave instead of Matlab. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| Before contributing, ensure you have: | ||
|
|
||
| - **For MATLAB/Octave**: MATLAB R2016b+ or GNU Octave 4.0+ | ||
| - **For Octave**: MATLAB R2016b+ or GNU Octave 4.0+ |
Comment on lines
164
to
166
| Inside the \"**examples/matlab**\" folder you will find several | ||
| MATLAB/Octave scripts that use MOLE to solve well known partial | ||
| Octave scripts that use MOLE to solve well known partial | ||
| differential equations. |
| The MOLE library contains many examples written in Octave and C++. These examples span a broad range of partial differential equations (PDEs). Below are more technical explanations of the examples included in the library. | ||
|
|
||
| **NOTE**: The name for both OCTAVE/MATLAB and C++ will be the same. The files `elliptic1D.m` and `elliptic1D.cpp` solve the same differential equation explained here under Elliptic1D. There are many more OCTAVE/MATLAB examples, so if you cannot find a C++ example, it is only in the OCTAVE/MATLAB folder. | ||
| **NOTE**: The name for both Octave and C++ will be the same. The files `elliptic1D.m` and `elliptic1D.cpp` solve the same differential equation explained here under Elliptic1D. There are many more Octave examples, so if you cannot find a C++ example, it is only in the Octave folder. |
| 1. **Testing**: Ensure all tests pass on supported platforms: | ||
| - Run `make run_tests` for C++ tests | ||
| - Run `make run_matlab_octave_tests` for MATLAB/Octave tests | ||
| - Run `make run_matlab_octave_tests` for Octave tests |
| ### Octave result | ||
|
|
||
|  No newline at end of file | ||
|  No newline at end of file |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
What type of PR is this? (check all applicable)
Description
Remove the "MATLAB/OCTAVE" references in most of the docs, change to "Octave".
The folders still have MATLAB, as well as some of the older reports have MATLAB listed. But, it should be clear now that the target is Octave, and we test for both Octave and MATLAB.
Related Issues & Documents
Read Contributing Guide and Code of Conduct
[optional] What gif best describes this PR or how it makes you feel?