Api cleanup - Githubissues

NREL / altrios

https://nrel.github.io/altrios/

Other

15 stars 2 forks source link

Api cleanup #15

Closed calbaker closed 7 months ago

calbaker commented 8 months ago

clarifies process for creating SetSpeedTrainSim and SpeedLimitTrainSim
switches to using RailVehicle directly in place of RailVehicleMap in several places but not exhaustively
adds new yaml versions of rail vehicle files and tests them: https://github.com/NREL/altrios/blob/cfcc11e401b89cd8c45b50d5e662803f8e1733e9/python/altrios/tests/test_rail_vehicles.py#L4-L17
various other changes to make API for constructing train simulations more clear

SWRIganderson commented 7 months ago

@calbaker I took a look at the examples in detail this evening. I think we should have more comments in the examples. I'm not saying you should do it though. This is on me too.

I also don't like the commented-out portions of the example that would be making plots. We should either make the plot or delete the code in my opinion.

I do like what you have done with the car yaml files instead of the csv. That seems a lot cleaner.

I have not looked at the rust changes in detail. I'll try to give it look on Thursday.

calbaker commented 7 months ago

@sakhtar312 could you try to get these tests passing?

sakhtar312 commented 7 months ago

@calbaker the tests are passing now. Installing the project in developer mode in tests.yaml file (adding -e flag to pip install .) did the trick.