robotology / whole-body-controllers

Simulink-based whole body controllers for humanoid robots.
116 stars 43 forks source link

Can we change the name of the repo? #109

Closed gabrielenava closed 3 years ago

gabrielenava commented 3 years ago

I think that whole-body-controllers is a very generic title, also the controllers in https://github.com/robotology/walking-controllers are whole-body-controllers.

This repo actually contains:

Fun fact: in walking-controllers there is a folder called WholeBodyControllers: https://github.com/robotology/walking-controllers/tree/master/src/WholeBodyControllers

will the change of name create big issues?

cc @DanielePucci @traversaro @diegoferigo @S-Dafarra @Giulero @GiulioRomualdi @carlottasartore (I will add other people if necessary)

traversaro commented 3 years ago

will the change of name create big issues?

No, we just need change the name of a few files in the robotology-superbuild, i.e.:

So, if we want to, no problem. However, I personal prefer to avoid endless bikeshadding discussion on naming, so as mantainer if you have a name that you prefer feel free to propose it, and if nobody objects we will change it.

traversaro commented 3 years ago

As this will change the projects tags files, probably @CarlottaSartore needs to be informed in time.

CarlottaSartore commented 3 years ago

Yes, as long as we are informed in time for changing the tags no problem from our side.

traversaro commented 3 years ago

Note that the only reason why the name in the project tags will need to be changed is just for how the superbuild works, the old repo name would still work fine when doing git clone, as GitHub handles redirects quite well.

DanielePucci commented 3 years ago

Go for me

gabrielenava commented 3 years ago

After a f2f discussion with @CarlottaSartore we decided to postpone the update of the repo name in March. Also I realized that all the documentation which refers to whole-body-controllers needs to be updated and this is not so short.

traversaro commented 3 years ago

After a f2f discussion with @CarlottaSartore we decided to postpone the update of the repo name in March. Also I realized that all the documentation which refers to whole-body-controllers needs to be updated and this is not so short.

Is the renaming still planned?

gabrielenava commented 3 years ago

Is the renaming still planned?

I think it would be nice to align the name of the repo with the one of matlab-whole-body-simulator, and therefore change it to matlab-whole-body-controllers. I think the two repos may have things in common. Maybe we can take a final decision in today's meeting @traversaro.

gabrielenava commented 3 years ago

In the end after listening to the feedback from @nunoguedelha I decided for simulink-whole-body-controllers because all controllers are Simulink models.

I am going to change just the name, I am not going to change the name of the library package (+wbc) otherwise all MATLAB/Simulink code that calls functions with the namespace wbc will be broken. So, the modification should only affect the documentation of some DIC repos.

I think modifications are required in both the CMake and the documentation of the robotology-superbuild, please @traversaro could you help me in understanding what needs to be modified there?

Other repositories whose documentation will be affected:

nunoguedelha commented 3 years ago

@gabrielenava , I've added this to the epic #113 as it is one of the actions listed there. Let me know if for any reason this is not ok for you.

gabrielenava commented 3 years ago

@gabrielenava , I've added this to the epic #113 as it is one of the actions listed there. Let me know if for any reason this is not ok for you.

fine to me @nunoguedelha!

traversaro commented 3 years ago

@gabrielenava can we move this in Ice-Box if you are not going to work on this?

gabrielenava commented 3 years ago

@gabrielenava can we move this in Ice-Box if you are not going to work on this?

ok for me!

gabrielenava commented 3 years ago

In the end, I decided to give up with this change of name, as time passed by, and it seems to me a minor change that will however result in a not small task - as we need to spend time to notify the name change, to update documentation, and so on.

I close the issue, I will reopen it if and when there will be space for this modification.