IRT-SystemX / ml4physim_startingkit

11 stars 2 forks source link

What's the point of the airfrans librairy ? #4

Closed Bulbille closed 10 months ago

Bulbille commented 10 months ago

Hello, In notebook 2, we use airefrans In notebook 3 and so on, we use lips.

All the trainings and benchmarks are done with lips library.

Mleyliabadi commented 10 months ago

Hello,

The LIPS framework is the main tool to import the dataset and to evaluate the outputs. It provides also a set of utilities facilitating the design and training of augmented simulators (neural networks). It will also be used for the final evaluation of models when they are submitted on Codabench and to attribute a score.

As the studied usecase concerns the Airfoil, we thought that providing some details concerning the Airfoil simulator (AirfRANS library) may be useful for the participants to better understand the use case. Otherwise, we are agree with you that you don't need this package for the challenge (however, it should be installed for the reasons that I explain in the following comment).

Concerning your second point, we don't have yet a Pypi repository for LIPS package, and I'm afraid that what you are trying to install might not be the appropriate repository. Try to follow the LIPS framework installation procedure by cloning the Github repository.

Don't hesitate to contact if you meet further problems or have other questions.

Mleyliabadi commented 10 months ago

Furthermore, the AirfRANS library is used to download the required data, import and preprocess them, and to evaluate the prediction from physics compliance point of view. Hence, it is necessary to install it, but you may not need to import it explicitly when you prepare your submission.

daviddanan commented 10 months ago

Nothing to add to Milad comments. For the airfoil usecase, and for user convenience, airfrans library required features are "wrapped" by LIPS. Here are the module Milad refers to where airfrans is directly used:

It is a mere implementation details. Closing the issue, if you have others questions on theses aspects, don't hesitate to reopen it.