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
138 stars 56 forks source link

📚[DOC]: Readme in the examples #75

Open cfd1 opened 9 months ago

cfd1 commented 9 months ago

How would you describe the priority of this documentation request

Low (would be nice)

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

It would be useful to have a Readme in each of the examples explaining what they are. Problem description, setup etc.

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

Some of the examples are covered by the main docs