mikesokolsky
commented
7 years ago There's not enough documentation to really follow this right now without reading through the source code itself. The readme refers to the examples, but they are not commented. Is there a place where the classes and their relationships are defined? There's a little documentation in the README about Tributaries, but exactly what they are and how the fit into the larger context of the package is missing for me. Also, docstrings?
Reviewed 13 of 33 files at r1. Review status: 12 of 26 files reviewed at latest revision, 3 unresolved discussions.
README.md, line 1 at r1 (raw file):
Python Link Budget Calculation/Management and General Modelling
Generally this feels more like it's explaining decisions and talking about gotchas rather than introducing what the package is, what it does, and how to use it. What is a tributary, why is this a DAG and how does that work, etc? See the PR-level comment.
README.md, line 6 at r1 (raw file):
This software package is meant to replace the manual-intensive spreadsheet method. This package is intended to permit the following major changes in our methodology:
who's methodology?
README.md, line 33 at r1 (raw file):
* `python setup.py install -f` * `pip install -r requirements.txt` * `d=${HOME}/.matplotlib; mkdir -p ${d} ; cd ${d} ; fc-list` matplotlib issue #2919
recognize this is a potential issue, but it doesn't seem appropriate for a general installation guide.
Comments from Reviewable
harrison-caudill
This change is