search

natcap / invest

InVEST®: models that map and value the goods and services from nature that sustain and fulfill human life.
Apache License 2.0
166 stars 68 forks source link

InVEST Readme could use a refresh #670

Open dcdenu4 opened 3 years ago

dcdenu4 commented 3 years ago

From this discussion, https://github.com/natcap/cookbook/pull/1#issuecomment-929720320, it seems like there is consensus that the InVEST Readme could use a bit of a review and overhaul.

emlys commented 2 years ago

is there a reason to keep README_PYTHON.rst and README.rst as separate files?

dcdenu4 commented 2 years ago

It's not clear to me the benefit of having these separated. I also realize that we don't provide any upfront info that points to the latest installers and using the GUI.

emlys commented 2 years ago

I realized that README_PYTHON.rst is referenced in setup.py/pyproject.toml - it's the text that shows up on our PyPI page. So maybe it does make sense to keep them separate.

davemfish commented 5 days ago

Building Python Packages

This section is not really in line with how most of us do this in practice:

pip install .

emilyanndavis commented 5 days ago

It would be worth making sure we have documentation around how InVEST talks to sub-repos (sample data, user guide, etc.) and how/when to update revision refs in the Makefile.