Docs enhancements #235
Docs enhancements #235
Conversation
|
Adding @karosc for some responses too. @aerispaha can you drop the link in for the draft built docs? |
upgrade pyshp dependency
|
Also going to add @wraseman here for some thoughts too. He's a fresh SWMMIO user and it would be good to get his reaction. |
|
@bemcdonnell and team, you can see the draft built documentation on readthedocs, here).
|
|
@aerispaha, for starters, you've done such a nice job on the documentation overhaul! I like the focus and the new feel - lighter and cleaner. The only suggestions I have are for the User Guide. I think it would be useful to make a sub header section (BOLD) how to "Edit model Parameters." Get the attention of those who are quickly scrolling through that you can use this to Edit/modify models. Also, for running models, you might cite PySWMM as the vehicle that is used. Lastly, maybe consider a separate page for notebooks and add it to the TOC. We can also provide documentation links from www.pyswmm.org if you'd like! Keep up the great work on this! I think it is an asset to the community and so are YOU! |
Major overhaul of the swmmio documentation that better organizes the API reference documentation, adds a User Guide with examples (including some silly examples), and provides a more concise introduction. I've also fixed most of the docstrings that were incorrectly formatted (although not all of the docstrings have been standardized).
Draft Docs
You can review the unreleased docs here
swmmio.Model from URL
Also included is a small new feature that allows us to instantiate a
swmmio.Modelobject with a url to a INP file somewhere on the network. This was handy for quickly testing things and made some of the docs more concise. For example, we can work with a big model hosted in the NCIMM-Black-White-Box repo like thisThis will download the remote INP file to a temp location, then instantiate the
Modelobject as usual.Closes #233
Closes #171
Closes #236
Closes #234