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. #84

Merged
merged 7 commits into from
Dec 10, 2024
Merged

Update Docs. #84

merged 7 commits into from
Dec 10, 2024

Conversation

ioannis-vm
Copy link
Contributor

  • Clens up README.md.
  • Fixes issue with spurious line breaks in jupyter notebook ouput.
  • Adds examples.
  • Adds instructions for cloning the repository with the submodule.

Remove redundant material which is now available in the documentation.
- Eliminate redundant line breaks in notebook output.
- Convert validation tests into examples, which can be refined later.
@ioannis-vm ioannis-vm changed the title Update Docs Update Docs. Dec 3, 2024
They result in warnings when the documentation is built.
Copy link
Collaborator

@zsarnoczay zsarnoczay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, ready to merge

@zsarnoczay zsarnoczay merged commit 1b491c1 into NHERI-SimCenter:master Dec 10, 2024
16 checks passed
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.

2 participants