Have a dedicated neighborhood property and a get_neighborhood method on Cell

[quaquel]

This picks up on a discussion in #2296. In the current code, we have method named Cell.neighborhood. This is an unfortunate name. So we agreed to split this into a property for the direct neighborhood (i.e. radius = 1) and a get_neighborhood method for larger radii. We had a bit of discussion on the names, but I decided to keep it simple: neighborhood and get_neighborhood. I have updated the docstrings to clearly explain when to use which one.

[EwoutH]

I like the general design!

Any performance implication on caching? Mostly good probably, right?

[quaquel]

just a quick observation about cellspaces. A random walk is now a one liner: self.cell.neighborhood.select_random_cell().

[EwoutH]

That’s really nice!

I would appreciate a deprecationwarning for neighborhood()

[quaquel]

I would appreciate a deprecationwarning for neighborhood()

AFAIK that is not possible because the name clashes with the property.

[EwoutH]

It looks like this does introduce some errors.

[github-actions]

Performance benchmarks:

Model	Size	Init time [95% CI]	Run time [95% CI]
BoltzmannWealth	small	🟢 -15.6% [-16.6%, -14.7%]	🟢 -19.6% [-19.7%, -19.5%]
BoltzmannWealth	large	🟢 -22.9% [-23.1%, -22.7%]	🟢 -17.7% [-18.3%, -17.1%]
Schelling	small	🔴 +11.3% [+11.0%, +11.7%]	🔵 +1.7% [+1.5%, +1.8%]
Schelling	large	🔴 +11.6% [+11.1%, +12.1%]	🔵 +0.4% [-1.0%, +1.7%]
WolfSheep	small	🔵 +1.4% [+1.2%, +1.6%]	🔵 +2.2% [+2.0%, +2.5%]
WolfSheep	large	🔵 +1.9% [+1.7%, +2.1%]	🔵 +1.4% [+1.0%, +1.8%]
BoidFlockers	small	🔴 +10.6% [+9.9%, +11.2%]	🔵 -0.7% [-1.5%, -0.1%]
BoidFlockers	large	🔴 +10.1% [+9.6%, +10.6%]	🔵 +0.4% [-0.4%, +1.0%]

[EwoutH]

These benchmark results are exactly opposite of #2308.

So seems to cancel out and are just based on an outdated branch or whatever.

[github-actions]

Performance benchmarks:

Model	Size	Init time [95% CI]	Run time [95% CI]
BoltzmannWealth	small	🟢 -20.5% [-21.6%, -19.4%]	🟢 -19.2% [-19.3%, -19.1%]
BoltzmannWealth	large	🟢 -22.8% [-23.0%, -22.5%]	🟢 -18.1% [-18.9%, -17.4%]
Schelling	small	🔴 +10.6% [+10.2%, +11.1%]	🔵 +1.7% [+1.5%, +1.9%]
Schelling	large	🔴 +12.2% [+11.6%, +12.8%]	🔴 +8.6% [+6.3%, +10.6%]
WolfSheep	small	🔵 +0.4% [+0.3%, +0.6%]	🔵 +1.0% [+0.7%, +1.2%]
WolfSheep	large	🔵 +1.7% [+0.7%, +2.8%]	🔴 +5.5% [+3.3%, +7.5%]
BoidFlockers	small	🔴 +12.7% [+12.2%, +13.3%]	🔵 +0.9% [+0.2%, +1.5%]
BoidFlockers	large	🔴 +12.0% [+11.7%, +12.4%]	🔵 +0.4% [+0.1%, +0.8%]

[EwoutH]

Was starting to type something about API compatibility and deprecation warnings, but then remembered this is all in the experimental space.

Love the experimental space!

[EwoutH]

Thanks, great to have it in!

Please make sure that pre-commit passes before merging. Always a bitch to clean up (done in 7037a32).