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.
This pull request includes updates to the documentation and examples for the
PINNx
library, focusing on adding detailed examples and improving the clarity of the documentation. The most important changes include adding a new quickstart example, updating the installation section, and renaming example files for consistency.Documentation enhancements:
README.md
: Added a detailed quickstart example demonstrating how to define a PINN with explicit variables and physical units.docs/index.rst
: Updated the installation section with a new quickstart example, providing step-by-step instructions for defining and solving a PINN problem.Content reorganization:
docs/index.rst
: Updated the user guide to reference the correct example file.docs/unit-examples-forward.rst
: Renamed example fileBurgers.ipynb
toburgers.ipynb
for consistency.General improvements:
docs/index.rst
: Enhanced the description ofPINNx
to include information about its integration with the BDP ecosystem and its capabilities for defining problems with explicit variables and physical units.