kegiljarhus / pyBEMT

Implementation of the Blade Element Momentum Theory for turbines and propellers in Python
MIT License
57 stars 17 forks source link

Installation docs #1

Closed rafmudaf closed 4 years ago

rafmudaf commented 4 years ago

It would be more straightforward to show the installation procedures in two sequential steps:

  1. Install the dependencies (i.e. the pip command you currently have included or by any other means)
  2. Add pyBEMT to the Python path (i.e. python setup.py install or pip install -e .)

Its a somewhat minor detail but will make the installation process more complete. As is, it may not be clear to a novice user whether the python setup.py install command will install the dependencies.

This is in reference to the JOSS review: https://github.com/openjournals/joss-reviews/issues/2480.

kegiljarhus commented 4 years ago

Thank you for the suggestion. This has been implemented in commit 97a4b1698462537218842415df5d3590e0b7ed90