Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RAMP Graphical User Interface(GUI) #141

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

SoniBhaveshh
Copy link

@SoniBhaveshh SoniBhaveshh commented May 12, 2024

An RAMP App.

This contribution introduces a user-friendly graphical interface (GUI) for the RAMP open-source tool. The GUI enhances the accessibility and usability of the RAMP tool by providing an intuitive interface for users to interact with.

With the GUI, users can easily input parameters, visualize simulation results, and navigate various functionalities of the RAMP tool without requiring extensive programming knowledge. Additionally, this contribution aligns with efforts to expand the capabilities and user base of the RAMP tool by providing a more accessible interface for both beginner and experienced users. Fore better understanding a short Video tutorial is there https://drive.google.com/file/d/1CZ8g5DOgo2e4h3vLrdSVpGt-KVbYaEVt/view

Moreover the provided .py file allows for customization according to specific user requirements. GUI can be packaged as a .exe executable file using PyInstaller, facilitating easy deployment and usage across different platforms without any need of python installation.

This Work is a part of my Master thesis with Nordhausen Hochschule University, which was completed in January 2024.
RAMP GUI

There are two RAMP GUI. One is Stand-alone RAMP GUI. which do not depends on .ui file of Qt. However you can still modify it manually without Qt designer studio.
Secondly it is also available with .ui file. This can help you if you wish to modify GUI using Qt designer studio.
With .ui file Dependency.
.ui file can be modified using qt designer studio
@SoniBhaveshh
Copy link
Author

SoniBhaveshh commented May 12, 2024

Not an expert in programming but i managed to make a GUI with all my possible efforts. It may not seem professional but it opens the door for further development. You may modify it to make it better version.

@Bachibouzouk
Copy link
Collaborator

Dear @SoniBhaveshh - this is impressive! Thank you for your contribution :) I think many non-programmers will enjoy this app

You mention this work is part of your master thesis which was in January 2024, does that mean you don't have resources to further work on the code?

The main problem of GUI for open source projects done during study is long-term maintenance. We don't have dedicated resources for this in the RAMP core dev team.

I would suggest we create a new repository in the RAMP-project organization, rather than including it in the RAMP repository. This way we can pin the RAMP version with which your code works and add a dedicated README.md with installation steps, licence, authorship etc.

Let us know if you would have time to help a bit on your side, then we will take a decision within the RAMP dev team :)

Again great work and thanks for sharing it :)

@SoniBhaveshh
Copy link
Author

Hi @Bachibouzouk
Thank you for your appreciation.

It's not completely about resources. Once my supervisor mentioned that they may continue developing it if they find a student to work on it. Today, I am writing again to my university to ask if they want to proceed with it or not.

Actually, I can do it and I have the potential to do it, but I don't want to. I think it is not good for my mental health, especially my eyes. I may sound funny and unprofessional, but I have a curious nature and I don't leave the PC until I solve the problem. This affects both my mental and physical health. The past six months of working on my master's thesis have been a great learning experience, and I feel that the learning process is never-ending. However, I do not wish to continue programming alongside my full-time job and hobbies because of constraints and health. I hope you can understand that.

Initially i may cooperate by coordinating among myself, dev team, and the university.
I will let you know as soon as I receive a reply from my supervisor.

Thanks again for your appreciation :)

@Bachibouzouk
Copy link
Collaborator

Hi @SoniBhaveshh,

Thank you for reaching out :)

To me it doesn't sound funny that you prioritize your health over continuing working for a project you did to complete your degree! Quite on contrary I find it make sense.

I have been thinking on how to incorporate your work into the RAMP project organization and I have different ideas depending on how much you could participate.

Based on what you explained I would only suggest solution with very minor involvement from your side, while still keeping your name in the loop:

  • as you committed all you work as nine commits 2 days ago this does not make too much difference regarding the git history if you create a new repository with solely the content of the RAMP_GUI folder. You could name this repository RAMP_GUI. Then we fork it into RAMP-project/RAMP_GUI and your previous research group does as well. With this solution it is clear that the GUI work stems from you and the number of fork of your project make your github profile better. This requires minimal amount of work from you (setting the repo on your side and making a single commit with the content of RAMP_GUI folder

  • alternatively we could create a bare RAMP-project/RAMP_GUI repository that you can fork and in which you can commit your work. This solution bears almost the same amount of work on your side

  • another solution is that we create RAMP-project/RAMP_GUI, we copy the content of RAMP_GUI ourselves and we acknowledge your contributions by co-authoring you in the commits and in an AUTHORS.rst file. With this solution we just need your github noreply email address

Let me know if one of those option suits you best or if you would like to do it yet another way.

@SoniBhaveshh
Copy link
Author

Update

HI @Bachibouzouk
I received below mentioned reply from my thesis supervisor.

''Hello Mr. Soni,
Now a new folder with your GUI is created in our in.RET github. (Link: https://github.com/in-RET/ramp_gui/tree/main)
The developers can then directly fork this file to the RAMP projects.
''

I am not sure which way is correct or best, but right now i am following what university tells me to do. You may later fork those files to RAMP projects later i guess. Let me know if there is any issue in this process flow, then i will talk with my supervisor.

@Bachibouzouk
Copy link
Collaborator

Let me know if there is any issue in this process flow, then i will talk with my supervisor.

Hello @SoniBhaveshh, thanks for contacting them and for reporting :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants