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

[WIP] Big Refactor #33

Merged
merged 67 commits into from Apr 17, 2019
Merged

[WIP] Big Refactor #33

merged 67 commits into from Apr 17, 2019

Conversation

MaximeBouton
Copy link
Member

@MaximeBouton MaximeBouton commented Mar 22, 2019

AutomotiveDrivingModels.jl Refactor

PR to refactor the structure of the package. Assign yourself to some tasks by editing this description.

For each new folder we should:

  • import the relevant piece of code from the current repository
  • open issues if you notice something weird or inefficient and we will fix it at the second pass
  • write tests
  • write doc strings
  • write a documentation page

New folder structure : folder (dependencies)

  • Roadways (no deps): roadway definition, roadway generation, projections, frenet frame
    • code moved
    • test written
    • doc written
  • VehicleDefinitions (no deps): abstract type, interface, current vehicle definitions - Raunak
    • code moved
    • test written
    • doc written
    • Question: Should we change the name to reflect Samantha Kim's comment ref. pedestrians
      should not be called vehicles. Further, should we include bicyclemodel with CAR, TRUCK etc
      as opposed to being a standalone thing as it is now?
  • States (roadways, agent definitions): current states definition and scenes - Raunak
    • code moved
    • test written
    • doc written
    • Question: What is the correct way to test constructors for example VehicleState and
      associated Base.show and Base.write methods?
  • CollisionCheckers (states, agent definitions): collision checking utilities
    • code moved
    • test written
    • doc written
  • Actions (roadway, states, agent definitions): interface, current action definitions
    • code moved
    • test written
    • doc written
  • FeatureExtraction: current feature extraction tools, helpers function to get neighbors and lane info
    • code moved
    • test written
    • doc written
  • DriverModels (roadway, states, actions, features): interface, current driver model
    • code moved
    • test written
    • doc written
  • Simulation: simulation , callbacks
    • code moved
    • test written
    • doc written

After the first pass:

  • make sure the tutorials still runs
  • we should tests other project on this branch of AutomotiveDrivingModels.jl,
    since this is just a refactor nothing should break.

Questions

  • Should we reexport Vec?
  • Should we reexport Records?

Notable changes

A lot of files are unused, we should not include them in the refactor. If they might be useful in the short term, just open an issue.
No 1d/2d splitting.
Rename filenames if it is relevant.

@MaximeBouton
Copy link
Member Author

@raunakbh92 Could you take a look at the agent definition interface I just pushed ?

@MaximeBouton
Copy link
Member Author

Let's merge 🎉

@coveralls
Copy link

Coverage Status

Coverage increased (+57.8%) to 77.503% when pulling 1b4a8b1 on big-refactor into 0786154 on master.

@MaximeBouton MaximeBouton merged commit fb73cf2 into master Apr 17, 2019
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.

None yet

2 participants