Improvements to the GitHub front page (README file)

FlowModelingControl / flowtorch

flowTorch - a Python library for analysis and reduced-order modeling of fluid flows

GNU General Public License v3.0

131 stars 45 forks source link

Improvements to the GitHub front page (README file) #23

Closed akaptano closed 2 years ago

akaptano commented 2 years ago

While the paper clearly states the problems that the software is designed to solve, and the target audience, it is less clear on the Github repository page. I recommend editing your README file to make it very clear that the software is for post-processing any kind of fluid flow data from a wide range of file formats, and the goal is to help researchers with fluid data have easy and flexible post-processing, verification, and analysis pipelines.

AndreWeiner commented 2 years ago

Hi Alan, I added a few sentences to the Why flowTorch section in the README; see the commit linked above. Let me know if the changes are sufficient by closing the issue. Thanks! Andre