jerbaroo / bridge-sim

Python library for concrete slab bridge simulation.
MIT License
1 stars 0 forks source link

Document how paths for responses are calculated #195

Open jerbaroo opened 4 years ago

jerbaroo commented 4 years ago

Currently, paths of calculated responses are calculated based on bridge name and loading parameters. At the very least document what is going on.

Perhaps it is best to include all the bridge parameters in the path (instead of using the bridge name). The downside of this is that filepaths will be too long on some OSes, however a mapping of long to short filepaths in some file can be used (already implemented).

jerbaroo commented 4 years ago

and just pushes the burden onto the user.

In https://github.com/barischrooneyj/bridge-sim/pull/188#issuecomment-695062282 I said that. Since the point of this library is to make life easy for users, the burden should not be pushed onto the user. Furthermore the work to be done on the library in contrast to the work done by (hopefully some :stuck_out_tongue_winking_eye: ) users would be small.

In summary I conclude it is best to include all the bridge parameters in the calculated path.