dessia-tech / genmechanics Goto Github PK

• I'm submitting a ...

  • bug report
  • feature request: improve documentation
  • support request => Please do not submit support request here, see note at the top of this template.

• What is the current behavior?

Running python dynamic_positions\crank_rod.py runs OK, and, looking at animation and controlling it in web browser work fine.
Examples are provided without much doc, so, user doesn't know where to go from there: how to impact code to measure/understand changes?

Another example python dynamic_positions\reduction_gear_1_stage.py runs also OK and prints bunch of stuffs: what does it mean? How to understand printed results? How to impact code to measure/understand changes?

• If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem Avoid reference to other packages

No bug.

• What is the expected behavior?

Improve documentation.

My understanding is that to use DessIA, user need to define its "inputs" and its "engineering workflow". In the crank_rod example, my understanding is that:

1. "inputs" contain stuffs like stiffness spring or omega (axis rotation): how to change them to see the resulting impact?

2. "workflow" (not sure what this is here) but could you document how to change it (minimal change) to see the resulting impact?

• What is the motivation / use case for changing the behavior?

Understand how to modify DessIA "bots" starting from user inputs and workflow.

• Possible fixes

• Please tell us about your environment:

  • branch: master
  • commit: 67b39f2
  • python version: 3.9.7 (anaconda)