TerrainBento / terrainbento

A modular landscape evolution modeling package built on top of the Landlab Toolkit.
https://terrainbento.readthedocs.io/
MIT License
19 stars 8 forks source link

Cmshobe/add model docs #56

Closed cmshobe closed 6 years ago

cmshobe commented 6 years ago

adding documentation for models: 002, 008, 010, 018, and 410. @kbarnhart some CI tests are failing but I am not quite sure why-- mind taking a look at this and merging as long as my documentation hasn't messed up the CI?

kbarnhart commented 6 years ago

00C = 008 + 004 (depth dependent + shear stress)

so documentation for 008 needs to acknowledged that it is the model program to use for models 008 and 00C.

model 000 has example for this.

does that help?

cmshobe commented 6 years ago

Yaaa thanks!

On Jun 27, 2018, at 4:43 PM, Katy Barnhart notifications@github.com wrote:

00C = 008 + 004 (depth dependent + shear stress)

so documentation for 008 needs to acknowledged that it is the model program to use for models 008 and 00C.

model 000 has example for this.

does that help?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

coveralls commented 6 years ago

Pull Request Test Coverage Report for Build 300


Totals Coverage Status
Change from base Build 258: 5.6%
Covered Lines: 1026
Relevant Lines: 1975

💛 - Coveralls
cmshobe commented 6 years ago

I found what was causing the CI problems-- no 'F_f' parameter in the docstring tests of some of the erosionDeposition-related models. Should be fixed now.

kbarnhart commented 6 years ago

Also, I wouldn't worry about the two failed CI tests.

AND!!!! This PR would bring us over 50% coverage! wooo!

cmshobe commented 6 years ago

@kbarnhart models 002, 008, 010, 018, and 410 are at 100%! I am off to Germany, but keep me updated and I can do more stuff when I get back on 7/23 if needed.

This took something like 15 hours for the 6 models including both documentation and testing, which includes something of a learning curve.

kbarnhart commented 6 years ago

Thanks for doing this and for estimating the time it took you! Merging!