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

Readme Update #26

Merged
merged 25 commits into from
Apr 7, 2024
Merged

Readme Update #26

merged 25 commits into from
Apr 7, 2024

Conversation

suzanmanasreh
Copy link
Contributor

@suzanmanasreh suzanmanasreh commented Apr 4, 2024

I committed some things a few months ago that I don't think are necessary for the repo anymore, so this PR removes them. I've checked the code still compiles.

@sbryngelson
Copy link
Member

examples/README.md seems somewhat useful (though I can imagine it being better); what's the motivation for removing it?

@suzanmanasreh
Copy link
Contributor Author

suzanmanasreh commented Apr 4, 2024

2 reasons. I wanted to create better images of the example cases with ray-tracing, but I don't have those yet and not sure when I will. The other part I don't like though is that the timestep sentence is incorrect and not explained well, so I thought of just removing it.

A better solution would be to add a simple example case the shows the adjusted timesteps for wbcs and point people to that for wbcs and case_diff_celltypes for sickles instead of listing timestep values directly, but I'm not sure if that would bloat the repo further.

@suzanmanasreh suzanmanasreh marked this pull request as draft April 4, 2024 17:37
@suzanmanasreh suzanmanasreh marked this pull request as ready for review April 6, 2024 00:36
@sbryngelson sbryngelson merged commit c38dd7d into comp-physics:master Apr 7, 2024
1 check 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