Kitware / pan3d

Other
10 stars 2 forks source link

Catalog Docs #69

Closed annehaley closed 6 months ago

annehaley commented 6 months ago

This PR is for docs changes that are relevant to #67. This includes a new tutorial page explaining how to use the Catalog Search Dialog. It also includes a minor refactoring (moving catalog modules to a new folder) and bug fix (related to the Pangeo catalog).

johnkit commented 6 months ago

Something's not working for me. On startup, pan3d-viewer raises this exception:

(test03-pan3d) john.tourtellott@turtleland5:~/projects/pan3d/git/pan3d$ pan3d-viewer --catalogs pangeo esgf --server
Traceback (most recent call last):
  File "/home/local/KHQ/john.tourtellott/.py3-venv/test03-pan3d/bin/pan3d-viewer", line 33, in <module>
    sys.exit(load_entry_point('pan3d', 'console_scripts', 'pan3d-viewer')())
  File "/home/local/KHQ/john.tourtellott/projects/pan3d/git/pan3d/pan3d/serve_viewer.py", line 25, in serve
    builder.viewer.start(debug=args.debug)
  File "/home/local/KHQ/john.tourtellott/projects/pan3d/git/pan3d/pan3d/dataset_builder.py", line 61, in viewer
    self._viewer = DatasetViewer(
  File "/home/local/KHQ/john.tourtellott/.py3-venv/test03-pan3d/lib/python3.9/site-packages/trame/decorators/klass.py", line 44, in decorated_constructor
    instance = klass(*args, **kwargs)
  File "/home/local/KHQ/john.tourtellott/projects/pan3d/git/pan3d/pan3d/dataset_viewer.py", line 71, in __init__
    self.state.available_catalogs = [
  File "/home/local/KHQ/john.tourtellott/projects/pan3d/git/pan3d/pan3d/dataset_viewer.py", line 72, in <listcomp>
    catalogs.get(catalog_name) for catalog_name in catalogs

Looking at dataset_viewer.py, the catalogs variable is passed in to DatasetViewer as a list, so it won't have a get() method... so there seems to be some inconsistency.

annehaley commented 6 months ago

Thanks for catching this @johnkit. The most recent change included importing a module called "catalogs", which resulted in a name conflict. I changed this in 72ca343 by renaming the import.