Add docstrings to RustSimDriveParams #141
Conversation
This takes a first pass at documenting the fields in RustSimDriveParams using code comments found elsewhere within the code and slightly updated for clarity where clarity could be given.
michael-okeefe
added
the
documentation
Based on: actions/runner#2468 Test failures appear to occur due to an out-of-memory error. This attempts to increase the swap-space size on Ubuntu.
The change to increase swap space didn't seem to help so reverting.
|
NOTE: I noticed the unit tests don't seem to be passing via Github Actions. I tried an experiment based on this thread to increase the swap space thinking it might have been a memory issue but that didn't work: Not sure at this point what is wrong with the automated tests although I wonder if it could be the "vehicle import" tooling since that requires network access? Just a wild guess at this point... |
Based on this thread, this could be a cause of the unit tests failing? Trying...
|
OK, not sure if this definitively fixed the unit tests but it appears to be a breaking change in numpy 1.24 and later that causes this. This shows up in one of the dependencies. I limited the max version of numpy to be <1.24 to fix but there's probably a better, more comprehensive fix involving updating all the deps. |
| pub favor_grade_accuracy: bool, | ||
| pub missed_trace_correction: bool, // if true, missed trace correction is active, default = false |
There was a problem hiding this comment.
@jakeholden , check out these doc strings
|
Also addresses #9 |
|
@jakeholden , @michael-okeefe should get most of the credit for this, FYI |
Fixes: https://github.nrel.gov/MBAP/fastsim/issues/348
The docstrings were added by referencing other parts of the code. Some were slightly adjusted to enhance clarity where possible.
NOTE: this also incorporates a change that seems to have fixed the unit tests not building in Github actions:
The root cause appears to be a breaking change in numpy 1.24 and later that causes an error in another dependency (pymoo?). I limited the max version of numpy to be <1.24 to fix. A more comprehensive fix might involve updating all the deps.