adding first notebook - basic usage

[jGaboardi]

This PR:

• adds a first most basic usage notebook
  • this notebooks:
    • builds from the example in README but boils it down even further
    • update the points generator helper and makes it more flexible
    • provides a concise narrative and a clear visual example
• adds notebooks reqs to pyproject.toml
• updates .precommit
• opting to leave the example in the README for now until we are more settled on the notebooks, etc.

---

• A follow up notebook will contain a higher dimensional points example
• What do we thing about including (something like) the points generator as a utility function within the fastpair package? -- One source for demos/notebooks + useful in tests/benchmarking.

xref:

• move Features to notebook? #38
• interest in modernizing? #20

cc @gegen07

[carsonfarmer]

• A follow up notebook will contain a higher dimensional points example

Cool, that seems like a good idea.

• What do we thing about including (something like) the points generator as a utility function within the fastpair package? -- One source for demos/notebooks + useful in tests/benchmarking.

Yeh that is probably a good idea. Having said that, I wonder if there is a nice module for tests that we could recommend to create various different types of random point patterns? PySAL must have this? Otherwise, just a random point utility module seems reasonable.

[carsonfarmer]

Love it!

[jGaboardi]

Yeh that is probably a good idea. Having said that, I wonder if there is a nice module for tests that we could recommend to create various different types of random point patterns? PySAL must have this? Otherwise, just a random point utility module seems reasonable.

Yes pointpats offers this, as well as a new geopandas that wraps pointpats (Levi & Martin put a ton of work into that). I think these are great option for an advanced use case demo, but the dependencies would really explode if they were to be used in tests.

I think this is worth further discussion and consideration and will open a new ticket for it.

On another note I am thinking that boiling the basic_usage demo even further by having hard-coded points would be an even better intro. Probably move the the random_points function to another demo when that happens. Leave as it for this PR.