Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #10

Merged
merged 2 commits into from
Dec 13, 2024
Merged

Update docs #10

merged 2 commits into from
Dec 13, 2024

Conversation

chaoming0625
Copy link
Member

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:

General improvements:

  • docs/index.rst: Enhanced the description of PINNx to include information about its integration with the BDP ecosystem and its capabilities for defining problems with explicit variables and physical units.

@chaoming0625 chaoming0625 merged commit 8f700ab into main Dec 13, 2024
5 checks passed
@chaoming0625 chaoming0625 deleted the update branch December 13, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant