DOC: refactor to federation structure

[sjsrey]

This tracks movement to the new doc structure

To Do

• user guide
• Documentation refactoring guidance pysal#1432

---

• resolves revisit outstanding items in docs build #399

[sjsrey]

@ljwolf to get the nb to compile I had to change the import. Do we want to change from camel case to snake case for consistency: f5cfeba

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.2%. Comparing base (182d9f4) to head (40a22f6).

Additional details and impacted files

@@          Coverage Diff          @@
##            main    #447   +/-   ##
=====================================
  Coverage   82.2%   82.2%           
=====================================
  Files         27      27           
  Lines       3965    3965           
=====================================
  Hits        3260    3260           
  Misses       705     705           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[leehach]

esda.shape.mass_moment_of_inertia should be replaced by esda.shape.moment_of_inertia_regions, not esda.shape.moment_of_inertia. That exists as a separate function, and now appears twice in toctree In 54cc3cb.

This is my error, as I added mass_moment_of_inertia, changed asi.rst, then replaced mass_moment_of_inertia with moment_of_inertia_regions, but did not update asi.rst.

The new functions that need to be added are:

esda.shape.moment_of_inertia_regions
esda.shape.moment_of_inertia_global

Additionally:

• esda.shape.second_moment_of_area is just an alias for esda.shape.moment_of_inertia
• esda.shape.second_areal_moment is deprecated
• esda.shape.moa_ratio is deprecated

Do aliases or deprecated functions stay in the toctree?

[sjsrey]

What remains is step 3 of pysal/pysal#1432.

But before this gets longer, maybe after reviews we can merge this to then finish the remaining step?

[jGaboardi]

re: "moment of inertia" vs. "second moment of area(area moment of inertia)"

I think I remember this being discussed by @leehach & @ljwolf previously, but can't find this discussion (or maybe I'm imagining). From my understanding in the geometric context this measure is generally referred to as area moment of inertia or second moment of area. I am getting confused?

[jGaboardi]

I think so far, so good (actually great). Just 2 point for all notebooks:

1. remove empty cells at the bottoms
2. clear output/content – that's all rendered each time they are rerun

[jGaboardi]

remove empty cells at end

[jGaboardi]

clear output

[leehach]

re: "moment of inertia" vs. "second moment of area(area moment of inertia)"

I think I remember this being discussed by @leehach & @ljwolf previously, but can't find this discussion (or maybe I'm imagining). From my understanding in the geometric context this measure is generally referred to as area moment of inertia or second moment of area. I am getting confused?

No, it's confusing.

This is what I posted about nomenclature in Discord (see https://discord.com/channels/1192517762103398401/1192517880219176961/1460621360429793394 for complete context).

The big picture question has to do with nomenclature. In Li, et al. (2013), they refer to "the second moment of an area about a point, also known as the moment of inertia (MI)." (p 1231). Different communities use different nomenclature, but we're citing an article that uses these terms interchangeably. The shapes module however has two functions, one called second_areal_moment(), which Li, et al. repeatedly refer to as moment of inertia, and another called moment_of_inertia(), which cites Altman (1998).

Therefore, the function moment_of_inertia returns the second moment of area.

Also, according to Wikipedia "second moment of area" is also known as "area moment of inertia".

[martinfleis]

• It is missing custom CSS.
• And I think we might also want the template, to mitigate the warnings.
• pysal-styles.css should be removed, it is replaced.
• some bibtex keys are not found but we can check those later.

[sjsrey]

Not sure why the search funtionality appears to not be working.