Refactor dependencies to make more optional

[Sevans711]

Closes #1224

Waiting for #1541 before asking to merge (in order to move hvplot from required to "viz").

Overview

Addresses user feedback asking to handle dependencies in a more elegant manner. Many previously-required dependencies are now optional. Also may speed up "import uxarray" slightly, as now-optional dependencies are moved to no longer be at top-level / top of files; instead, they are imported the first time any relevant method gets called. Imports of some required dependencies were similarly moved, to possibly improve "import uxarray" timing.

Notes about all dependencies which were previously listed as required in pyproject.toml:

• antimeridian: important for geometry → keep as required. [EFF] Efficiency note: antimeridian was already never being imported at top-level.
• cartopy: used only in plotting → viz
• dask[dataframe]: keep as required for now. But, it is only used in core.aggrecation and core.zonal, so maybe could make optional? [EFF] already never at top-level.
• datashader: not used explicitly anywhere → removed
• geoviews: used only in examples, for plotting → viz
• holoviews: used only in examples, tests, and HoloviewsBackend for plotting → viz
• matplotlib: used only for plotting → viz
• matplotlib-inline: not used explicitly anywhere → removed
• netcdf4: not used explicitly, but everyone is reading .nc files → keep as required
• numba: keep as required, of course
• numpy: keep as required, of course
• pandas: important for grid methods, e.g. pd.Series and pd.IntervalIndex used explicitly → keep as required
• pyarrow: not used explicitly, and dask[dataframe] already depends on it → removed
• requests: not used explicitly anywhere in uxarray → removed
• scikit-learn: important for neighbor algorithms, e.g. KDTree → keep as required. [EFF] already not at top-level.
• scipy: important for delaunay triangulations and some io → keep as required. [EFF] removed from top-level.
• shapely: important for geometry → keep as required. [EFF] already not at top-level.
• spatialpandas: just for spatialpandas.GeoDataFrame conversions; should be optional → geo
• geopandas: just for geopandas.GeoDataFrame conversions; should be optional → geo
• xarray: keep as required, of course
• hvplot: used only for plotting → viz. Didn't move it yet though; waiting for Speed up import and load hvplot lazily #1541 to get merged
• healpix: just for healpix grids; should be optional → geo
• polars: used explicitly for some internal methods → keep as required
• pyproj: only used in uxarray.cross_sections.sample.sample_geodesic; should be optional → geo

Miscellaneous notes:

• removed pathlib; pathlib became a built-in part of the standard library in Python 3.4, and the pyproject.toml requires Python >= 3.10.
• added "all" as alias for "complete" because many libraries use "all"; see example usage below.
• added pooch to "dev" dependency group, because pooch was secretly required in order for all tests to pass. Comment in test/io/test_structure.py clarifies why pooch dependency exists despite not being imported explicitly anywhere in uxarray.

Expected Usage

Users can now install uxarray with optional dependency groups. Simple examples with pip interface:
Required dependencies only:

pip install uxarray

Also includes all optional dependencies related to geospatial grids (geopandas, healpix, pyproj, spatialpandas)

pip install "uxarray[geo]"

Also includes everything related to geospatial grids, plus everything related to visualization (cartopy, geoviews, holoviews, matplotlib)

pip install "uxarray[geo,viz]"

Includes all required plus all optional dependencies:

pip install "uxarray[complete]"

Equivalent to above: pip install "uxarray[all]"

PR Checklist

General

• An issue is linked created and linked
• Add appropriate labels
• Filled out Overview and Expected Usage (if applicable) sections

Testing

• Adequate tests are created if there is new functionality
• Tests cover all possible logical paths in your function
• Tests are not too basic (such as simply calling a function and nothing else)
• Question: should we add something to test suite to ensure you can at least import uxarray after doing pip install uxarray with minimal dependencies? We could maybe add a few more tests for different combinations of dependencies too?

[rajeeja]

One thing to flag: anyone doing pip install uxarray and then using plotting will now hit an ImportError until they install [viz]. This is intended per #1224, but it's a meaningful change to the default install contract, so I think we need a broader discussion before merging. @erogluorhan — can you weigh in on how we want to handle the default UX and messaging here?

[Sevans711]

One thing to flag: anyone doing pip install uxarray and then using plotting will now hit an ImportError until they install [viz]. This is intended per #1224, but it's a meaningful change to the default install contract, so I think we need a broader discussion before merging. @erogluorhan — can you weigh in on how we want to handle the default UX and messaging here?

I definitely agree, we should make sure to discuss more before merging. I am curious to know what people think.

One thought I had is: something that might help could be to provide hints during those crashes. Something like:

def function_that_uses_holoviews(*args, **kwargs):
    try:
        import holoviews as hv
    except ImportError as err:
        raise ImportError('holoviews import failed; to install all plotting dependencies, could do: pip install "uxarray[viz]".') from err
    # << code from function

As opposed to the code presently in the PR, which just does import holoviews as hv.

Although, this doesn't match xarray's style. In xarray, if you fail to install optional dependencies you will just see an ImportError crash once you try to use them, there's no hint to pip install xarray[viz] or anything like that.

Another slight downside is that this option might get a bit unwieldy due to the need to repeat it inside every relevant method. A partial workaround could be to handle these hints all in one place:

# --- inside new file: utils.imports.py --- #
def _import_with_hint_if_error(*modules):
    """import modules, but make nice error if crash, providing hint to pip install "uxarray[...]".
    E.g., if 'holoviews' in modules, and import holoviews fails, hint to use: pip install "uxarray[viz]".
    """
    if 'holoviews' in modules:
        try:
            import holoviews as hv
        except ImportError as err:
            raise ImportError('holoviews import failed; to install all plotting dependencies, could do: pip install "uxarray[viz]".') from err
    if 'geoviews' in modules:
        # similar
    # similar for all other optional dependencies.

Then functions with optional dependencies can look like:

from uxarray.utils.imports import _import_with_hint_if_error

def function_that_uses_holoviews_and_geoviews(*args, **kwargs):
    _import_with_hint_if_error('holoviews', 'geoviews')
    import holoviews as hv
    import geoviews as gv

I actually have a slight personal preference to do something like that; I think user experience is improved when common errors include debugging hints. But, I'm happy to go with whatever we decide together.