V0 vs desiredSpeed

[chraibi]

All models use v0 to set up the desired speed. All but the social force model (desiredSpeed)

Although, v0 is kinda standard name, desiredSpeed is more inline with the other parameters like reactionTime or forceDistance.

I think maybe we should replace v0 everywhere with desiredSpeed. What do you think?

[chraibi]

related to #1415

[Ozaq]

I see two principal routes to go:
A.) We deprecate 'v0' but do not remove it and introduce 'desiredSpeed', e.g. 'v0' is just an alias. This would make the change non-breaking, which means we can address it in a minor release.

B.) We rename as suggested but postpone this to a 2.0

[sean-reed]

I agree that the API would be better to use a consistent naming. For me v0 could also be confused with specifying the initial speed of the agent, so desiredSpeed is a better name. I suggest route A) and raise a DeprecationWarning for use of v0 then remove it altogether in the next major release.

[chraibi]

Yes, both of you are right. We have an open PR #1440 that does this and more.