esda icon indicating copy to clipboard operation
esda copied to clipboard

what to do with `tools/moran_*.ipynb` (if anything)?

Open jGaboardi opened this issue 5 months ago • 5 comments

What should we do with the tools/moran_* noebooks?

  • nothing – simply keep in tools/
  • keep in tools/ but update (and keep updated) - (add pygeoda & geosnap to optional reqs)
  • rename tools/ to something more appropriate – benchmarking, diagnostic, etc
  • move into notebooks/ and exclude from copying to docs/
  • move into notebooks/ and copy to docs/
  • something else

xref https://github.com/pysal/esda/pull/368#issuecomment-3016726980

jGaboardi avatar Jun 29 '25 14:06 jGaboardi

nothing? Do they bother you there? :)

martinfleis avatar Jun 29 '25 14:06 martinfleis

Bother me? No. Just not sure what purpose they serve since they haven't been touched in 5 years and were last run Python 3.7 seems like.

jGaboardi avatar Jun 29 '25 14:06 jGaboardi

Maybe more important is that they will not work as there's no numba keyword in Moran_Local for example, which I missed earlier.

martinfleis avatar Jun 29 '25 14:06 martinfleis

Considering your point there, I added 2 more bullets to options

jGaboardi avatar Jun 29 '25 15:06 jGaboardi

Since these were added by @darribas , maybe we can get his thoughts if he has a moment?

cc @sjsrey @knaaptime @ljwolf @weikang9009

jGaboardi avatar Jun 29 '25 15:06 jGaboardi

These were notes we developed when we were building the numba-based randomisation engine for LISAs and local stats. In some ways, they’re travel notes, not really documentation. Appropriately flagged, they could probably live in notebooks, but then I’d imagine they’d need to be updated as there’d be an expectation that code in that folder runs. If you want cleanness, they could be removed and left in the git history if you think they confuse users. It was useful code to make sure we were not breaking anything and to get a sense of how performant the new code was. But, given the code is now properly tested, perhaps it’s not as relevant to keep?

darribas avatar Jul 08 '25 20:07 darribas