search

tretherington / nlmpy

A Python package to create neutral landscape models
MIT License
11 stars 3 forks source link

Wiki examples for better documentation #3

Open tretherington opened 3 years ago

tretherington commented 3 years ago

To improve the documentation of the functions I think it would be great to write some wiki examples that show case and explain how the various NLM functions work. Perhaps pictures of real landscapes can be shown, and then how to mimic those landscapes using NLMpy?

tretherington commented 2 years ago

This is definitely worth doing, and should provide guidance on how to choose parameters such as h in the midpoint displacement algorithm.

tretherington commented 2 years ago

GitHub Pages seems to have advanced to a point where a dedicated website may be more helpful and intuitive.

DOSull commented 2 years ago

I've had some fun with pdoc for documentation, see https://dosull.github.io/weaving-space/doc/weavingspace/index.html and the project page is https://pdoc3.github.io/pdoc/

If you link in some notebooks with usage guides from the documentation page headers, then I think you get a good blend of low level detail and higher level explanation

DOSull commented 6 months ago

Another option is the kind of website you can make easily with quarto, which can be hosted on pages. See e.g., dosull.github.io/computing-geographically -- that site is mainly R, but quarto handles python notebooks equally well and has templates for blogs, books, etc.