OpenTire / OpenTirePython

An open-source mathematical tire modelling library
MIT License
45 stars 17 forks source link

OpenTire Demo #6

Open kktse opened 7 years ago

kktse commented 7 years ago

OpenTire doesn't seem to have much in terms of examples and documentation. Starting on some documentation would make OpenTire much more appealing to use and lower the cost-to-entry of using the library.

We could create a demo application that uses OpenTire that demonstrates some basic operations of OpenTire. It would serve both demonstrative and documentation purposes.

The demo app doesn't have to be anything complicated, maybe a simple visualisation of the 02 coefficients from the Pacejka textbook. Basics like FY vs SA, FX VS SR, FY vs FX...

I have been meaning to try the library with a YMD simulation but the lack of documentation makes it a challenge. A simple application would show what OpenTire can do.

ho1 commented 7 years ago

All great points - making it easier to get started with using tire models is one of the key goals with OpenTire. The testEnv.py is a very basic example but it would definitely make sense to build that out further and also provide some documentation on the API and some getting-started type tutorials.

I hope to push up the PAC2012 (compatible with MF6.1) formulation later this year, which will make OpenTire compatible with the models commonly used in industry today. After it would be appropriate to build out examples.

Do you think examples should just be something simple "script"-like, or should would it make sense with a GUI application for interacting with models?

kktse commented 7 years ago

I am putting myself here on the spot here trying to think of some scenarios as I go through the library a bit more. Here are some questions that I think would be best answered by some demos

1 - How do I start using OpenTire? A simple 'Hello World!' style script that initializes OpenTire, creates the most primitive model with default coefficients, shows how to perform a calculation, extracts the results and outputs a pretty table with the results.

I didn't notice the testEnv.py script and I also learned about the Gist on OpenTire.org! These are definitely the types of examples that would answer this question.

2 - How do I make OpenTire work for my specific application? Maybe a simple script that shows some of the save/load/modify capabilities of the library. Probably the biggest challenge are all the different ways to manipulate the Pacejka coefficients and how to save/load them. .TIR file templates and demos would be super helpful too.

3 - I want to use IPython notebook with OpenTire! How do I do that? Thinking more about the scientific computing community on this one. It would be a good way to show how OpenTire will fit in with the IPython notebook 'style' of working.

4 - I have some tire coefficients and some tire data, how can I test OpenTire if I can use this library? A simple GUI application that can save/load/manipulate/visualize the tire coefficients and show some pretty plots of FY vs SA, FX vs SR so users can gain an appreciation of whether OpenTire is right for them.

Demos for 1 & 2 would be the most helpful and the easiest to implement. Shouldn't take too long and I would be glad to help here. A demo repo or folder might not be a bad idea too when you get more and more example scripts.

Pundarikm37 commented 1 year ago

hi, could not see much of development in this module. also i am not able to find any import data feature, as i have multiple tyre models ( .tir ) to test. please suggest in case i am missing anything.

ho1 commented 1 year ago

Please see the example here for how to load in TIR file: https://github.com/OpenTire/OpenTirePython/blob/6652c49031071f70cba9080a2837fdd95b7317a7/code/testEnv.py#L24

On Sun, Nov 20, 2022 at 10:35 PM Pundarikm37 @.***> wrote:

hi, could not see much of development in this module. also i am not able to find any import data feature, as i have multiple tyre models ( .tir ) to test. please suggest in case i am missing anything.

— Reply to this email directly, view it on GitHub https://github.com/OpenTire/OpenTirePython/issues/6#issuecomment-1321489289, or unsubscribe https://github.com/notifications/unsubscribe-auth/AC5FRVWARNTG3AOGCBUITYLWJMCZPANCNFSM4CTTGIWQ . You are receiving this because you commented.Message ID: @.***>