Skip to content

Docs user guide#496

Open
sjsrey wants to merge 75 commits into
pysal:mainfrom
sjsrey:docs-user-guide
Open

Docs user guide#496
sjsrey wants to merge 75 commits into
pysal:mainfrom
sjsrey:docs-user-guide

Conversation

@sjsrey

@sjsrey sjsrey commented May 11, 2026

Copy link
Copy Markdown
Member

New notebooks: Getis-Ord G/G_i* hotspot analysis, Geary's C (global
and local), Getting Started overview. New Spatial Clustering section
moves A-DBSCAN out of Diagnostics. Proposing example section landing pages to now include
method-choice guidance. Added learning goals and takeaways to
correlogram, LOSH, and topo notebooks for consistency.

@codecov

codecov Bot commented May 11, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 91.20879% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.2%. Comparing base (8c05bdb) to head (b71856c).
⚠️ Report is 30 commits behind head on main.

Files with missing lines Patch % Lines
esda/inspection.py 89.7% 6 Missing ⚠️
esda/losh.py 66.7% 1 Missing ⚠️
esda/moran.py 96.6% 1 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #496     +/-   ##
=======================================
+ Coverage   85.8%   86.2%   +0.3%     
=======================================
  Files         27      28      +1     
  Lines       3625    3702     +77     
=======================================
+ Hits        3112    3191     +79     
+ Misses       513     511      -2     
Files with missing lines Coverage Δ
esda/__init__.py 100.0% <100.0%> (ø)
esda/getisord.py 89.4% <ø> (+1.4%) ⬆️
esda/shape.py 72.4% <ø> (ø)
esda/util.py 90.9% <ø> (ø)
esda/losh.py 95.7% <66.7%> (+0.3%) ⬆️
esda/moran.py 84.8% <96.6%> (+1.1%) ⬆️
esda/inspection.py 89.7% <89.7%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@martinfleis martinfleis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Superb job!

Some of these notes are not entirely related to these changes but I noticed the while reviewing.

There's a bunch of warnings in the adbscan notebook about missing Numba. We should use the env with Numba to build the docs imho.

The LOSH notebook has a formula under Inference on the LOSH statistic section that does not render correctly. Not even locally in VS Code.

It seems that the linting/pre-commit does not pick unsorted imports in notebooks (e.g. correlograp.ipynb, cc @jGaboardi) edit: now I see the failing pre-commit...

The Berlin data in the Geary notebook require a ton of preprocessing... since we host it, can we host pre-processed version, if we want to stick to the data? joins, sjoins, renames... it is just noise in those notebooks.

When doing new notebooks, can we use Graph?

Having local C and local G under Global autocorrelation is a bit strange, not sure if split to global-local is optimal structure in this context. I like that it is in the same notebook, so maybe combining local and global sections to one?

Comment thread docs/source/user-guide/getting_started.ipynb
Comment thread docs/source/user-guide/LOSH.ipynb
@sjsrey sjsrey marked this pull request as ready for review June 12, 2026 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants