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

move examples to WaterLily-Examples #156

Merged
merged 11 commits into from
Aug 2, 2024

Conversation

marinlauber
Copy link
Member

No description provided.

@codecov-commenter
Copy link

codecov-commenter commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

see 10 files with indirect coverage changes

@weymouth
Copy link
Collaborator

This is showing up as breaking the CI. Is that just the code coverage?

@marinlauber
Copy link
Member Author

Yes, my bad, the documenter was using some stuff in examples/ it's sorted now.

@weymouth
Copy link
Collaborator

weymouth commented Aug 1, 2024

Do we want to clean up the README since all of those examples are now in another repo? Maybe we can focus the WaterLily README and point them straight over to the tutorials?

Here is a short version of the README. I've replaced all the examples with a simple circle flow tutorial. That's it...
README.md Outdated
# don't forget to close the file
close(writer)
using CUDA
@assert CUDA.functional() # is your CUDA GPU working??
Copy link
Member Author

Choose a reason for hiding this comment

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

Is that still useful? The extension does it when you load it already, right?

Copy link
Collaborator

Choose a reason for hiding this comment

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

On my machine at home, using CUDA doesn't throw any error, so the @assert is needed to stop people from following the example blindly.

@weymouth weymouth merged commit 771d263 into WaterLily-jl:master Aug 2, 2024
21 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.

3 participants