You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The kinematics.py file is already big, and when the in-progress PRs are merged (especially #315, #277, #280), it will be much bigger, which will make it unwieldy to handle.
Proposed solution
Split the kinematics.py file into multiple modules, for example:
kinematics.py: this will contain functions for measuring derivatives - velocity, acceleration, displacement, speed, and perhaps also pairwise distances?
navigation.py: this can contain the functions for forward_vector, head_direction_vector, heading, path_length
The first file could also be called derivatives.py, but I don't know if, say, distances would fit neatly in that. I'm open to other (hopefully better) splitting "ontologies".
Despite splitting the files, I propose to still keep a unified kinematics namespace. So to the users, nothing will change. All functions that are currently in kinematics.py will still be importable as from movement.kinematics import function. We can do this by fiddling with the __init__.py files.
Alternative
We could also split the namespace together with the files, so we have movement.kinematics and movement.navigation (or whatever categories we settle for). That could be easily achieved by splitting the files without doing anything in the __init__.py.
But if we go for this option, I'd want the semantic separation to be "clean". If we just separate the files, without affecting the user, we can afford to be fuzzier with our splits.
Problem
The
kinematics.py
file is already big, and when the in-progress PRs are merged (especially #315, #277, #280), it will be much bigger, which will make it unwieldy to handle.Proposed solution
Split the
kinematics.py
file into multiple modules, for example:kinematics.py
: this will contain functions for measuring derivatives -velocity
,acceleration
,displacement
,speed
, and perhaps also pairwise distances?navigation.py
: this can contain the functions forforward_vector
,head_direction_vector
,heading
,path_length
The first file could also be called
derivatives.py
, but I don't know if, say, distances would fit neatly in that. I'm open to other (hopefully better) splitting "ontologies".Despite splitting the files, I propose to still keep a unified
kinematics
namespace. So to the users, nothing will change. All functions that are currently inkinematics.py
will still be importable asfrom movement.kinematics import function
. We can do this by fiddling with the__init__.py
files.Alternative
We could also split the namespace together with the files, so we have
movement.kinematics
andmovement.navigation
(or whatever categories we settle for). That could be easily achieved by splitting the files without doing anything in the__init__.py
.But if we go for this option, I'd want the semantic separation to be "clean". If we just separate the files, without affecting the user, we can afford to be fuzzier with our splits.
Additional context
analysis
level #320The text was updated successfully, but these errors were encountered: