search

tretherington / nlmpy

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

Update README and create wiki examples to correct for changes from software paper #9

Open tretherington opened 6 months ago

tretherington commented 6 months ago

Folks are hitting issues when using the software paper and associated supplementary materials as these are now outdated as:

  1. The import statement has changed
  2. The blendArrays function has changed.

I think this could be resolved by:

  1. Adding a more explicit warning when mentioning the software paper that these things have changed.
  2. Creating new versions of the example scripts as wiki examples, so that folks can access updated versions of the code examples that can be maintained going forward.
DOSull commented 6 months ago

The joys of replicable research.

I wonder if on the README for the repository, which many readers will surely visit, links to updated current working versions of the scripts to generate the two figures (or even jupyter notebooks doing the same) could be prominently placed. Say, for example where it says

A full description of the package can be found in the accompanying software paper.

could be updated to

A full description of the package can be found in the accompanying software paper (updated scripts to produce the figures in the paper from the latest version of the code, are available here).