NVIDIA / modulus-sym

Framework providing pythonic APIs, algorithms and utilities to be used with Modulus core to physics inform model training as well as higher level abstraction for domain experts

https://developer.nvidia.com/modulus

Apache License 2.0

137 stars 56 forks source link

Add master readme for reservoir examples #139

Closed ktangsali closed 3 months ago

ktangsali commented 3 months ago

Modulus Pull Request

Description

Add a summarized Readme for reservoir examples folder.

Checklist

[ ] I am familiar with the Contributing Guidelines.
[ ] New or existing tests cover these changes.
[ ] The documentation is up to date with these changes.
[ ] The CHANGELOG.md is up to date with these changes.
[ ] An issue is linked to this pull request.

Dependencies

ktangsali commented 3 months ago

Looks good for a first draft. I think we could add a few more details since the current wording is very generic.

Thanks @ram-cherukuri. I think the idea is to guide the users to the individual readmes for details. We can continue to refine this further as more stuff gets added here.

ktangsali commented 3 months ago

/blossom-ci