search

ccaprani / pycba

Python Continuous Beam Analysis
https://ccaprani.github.io/pycba/
Apache License 2.0
64 stars 29 forks source link

Some Documentation Suggestions #3

Closed mayermelhem closed 2 years ago

mayermelhem commented 2 years ago

Fantastic package. Please find below some first comments on the documentation upon my early trials of the program:

  1. Installation should say pip install -e . and not pip install . -e

  2. eType seen in the tutorials is not made clear that it is element type (or eletype kwarg). Suggest under beam configuration including the eletype kwarg in the Element Type Header in brackets, to be analogues to other headers that present their kwargs.

  3. It is not abundantly clear the default vehicle direction for moving loads (my guess from tutorial plot was left to right end support, first axle followed by second axle), nor if a reverse direction can be explored.

On 3, some functions found here, could be useful to integrate in PyCBA

ccaprani commented 2 years ago

Thanks @mayermelhem ; addressed in a010fd4; added a basic reverse vehicle feature too.

Those referenced functions are great - lots of good functionality that could be added here. I'd rather not take credit for moving them over - would you consider a PR?