search

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

Finalize model documentation #38

Closed kbarnhart closed 6 years ago

kbarnhart commented 6 years ago

@Glader011235 @cmshobe @gregtucker

This commit is intended to provide a guide to splitting up finalizing the documentation and testing of the remaining model program files.

Crib notes: Make the docstrings look like model 000's. Add tests for each model like those for model 000 in the test folder. Ideally we get 100% coverage for EVERYTHING!

Some recent changes: We no longer use nose. This means that you can't type from nose.tools import assert_raises. Don't freak out you can do import pytest and then pytest.raises(). I've changed this everywhere in the existing tests already so you can take inspiration examples from within terrainbento (but landlab still uses nose). Why did I do this... because nose isn't being maintained and its developers recommend using py.test.

This is what I propose to start:

  1. Me: All Rock/Till models: (800/804, 802, 808, 810, 840, 842, A00, C00)
  2. @cmshobe : Start with 002, 008/00C, 010, 018, 410
  3. @Glader011235 : start with 040, 400, 440, CCC

I'd recommend that you do one or two, and then create a PR in case there is anything else to clarify.

Still to be assigned: The stochastic ones: 100/104, 102, 108, 110 the VSA ones: 200/204, 202, 208, 210, 300

@gregtucker will claim some of these when he can.

I am almost done getting the Travis/Coveralls CI to work right. 🤞 I'll make a comment when that's done.

kbarnhart commented 6 years ago

FYI @cmshobe @Glader011235 you can commit directly into this repo instead of using a fork (like you do in landlab). This is because I added you as contributors to the repository.

kbarnhart commented 6 years ago

OK! Travis and Docs are all working. I'm nearly certain Coveralls is working. I'll test it and report back!

cmshobe commented 6 years ago

status update: I've done the documentation for 002, 008, 010, 018, and 410 (#56) so just need to do the tests next. @kbarnhart can you remind me what 00C is? Is this just some alternative parameterization of 008?

kbarnhart commented 6 years ago

Quick note. @gregtucker currently taking 100/104, 102, 108, 110

kbarnhart commented 6 years ago

current status:

Remaining for tests only: 808, 810, 840, 842, A00, C00 (assigned to me) ErosionModel (assigned to me) StochasticErosionModel (assigned to me)

Remaining for Docs and Tests: 100/104, 102, 108, 110 (assigned to @gregtucker) 012 (not yet assigned) 200/204, 202, 208, 210, 300 (not yet assigned)

kbarnhart commented 6 years ago

Another update on the status of remaining models:

All done (nice job everyone!)

Assigned to me:

Assigned to @Glader011235

Assigned to @gregtucker

cmshobe commented 6 years ago

since nothing is assigned to me (much appreciated!) and I'll be MIA for the next week, I will plan to finish whatever Rachel has left when she leaves for Alaska.

On Fri, Jul 13, 2018 at 8:21 AM, Katy Barnhart notifications@github.com wrote:

Another update on the status of remaining models:

All done (nice job everyone!)

  • 000, 002, 008, 018, 040, 400, 410, 440, 800, 802, and C00

Assigned to me:

  • 010 and 410 need small tweaks to permit thresholds to be passed successfully.
  • End member analytical unit tests for 808, 810, 840, 842, A00, C00
  • Finalize ErosionModel and StochasticErosionModel tests
  • Documentation and end member analytical tests for 300

Assigned to @Glader011235 https://github.com/Glader011235

Assigned to @gregtucker https://github.com/gregtucker

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/TerrainBento/terrainbento/issues/38#issuecomment-404737943, or mute the thread https://github.com/notifications/unsubscribe-auth/AJBvYE0HRrteoa875pfQdn9h9qGDY4E6ks5uGDxNgaJpZM4UzF1S .

kbarnhart commented 6 years ago

@cmshobe that is a great plan!