Skip to content

Topochanges - WIP - #245

Open
rjleveque wants to merge 2 commits into
clawpack:devfrom
rjleveque:topochanges
Open

Topochanges - WIP#245
rjleveque wants to merge 2 commits into
clawpack:devfrom
rjleveque:topochanges

Conversation

@rjleveque

Copy link
Copy Markdown
Member

I added a topochanges.rst file to give an overview of the recent changes to topo and dtopo. Still working on this so it is incomplete. I also added warnings to many files about the changes, and started tweaking some other things.

I moved the new text @mandli added in topotools.rst to topotools_module.rst since that's where we describe the Python tools.

Currently I'm having the following problems:

I temporarily merged this into dev and rebuilt the docs, so you should be able to view the latest in the dev branch at https://www.clawpack.org/dev/topochanges.html, along with other changes recently merged into dev. However, the build is currently failing on github, and failed again when I restarted it, see https://github.com/clawpack/clawpack.github.com/actions/runs/31121132472

For some reason several of the links in the seealso at the top of topochanges.html and elsewhere are not working, e.g. dtopo and netcdf_input.

When I rebuilt the docs I got lots of errors about Riemann solvers not being properly installed, but when I try to install using the recommended approach I get a new error I haven't encountered before:

$ pip install --user --no-build-isolation -e ./
ERROR: Can not perform a '--user' install. User site-packages are not visible in this virtualenv.

Note: When I tried to build with all versions using:

make versions

ran into this problem. I was able to get past it by pip installing sphinx-multiversion-scylla as recommended by Google AI.

Also make html still works to make the html from the branch checked out in _build1/html.

@rjleveque
rjleveque requested a review from mandli August 6, 2026 18:25

@mandli mandli left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of comments so far. I am in the midst of re-evaluating some of the parameter names to reduce confusion (e.g. extent). Also refactoring some of the existing functions to use the new apparatus, maintaining shims for backward compatibility, but may be deprecated.

Comment thread doc/changes_to_master.rst
t.read('old.tt1', topo_type=1) # DeprecationWarning
t.write('new.tt2', topo_type=2)
topo = Topography()
topo.read('old.tt1', topo_type=1) # gives DeprecationWarning

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we discussed, should this be a Warning instead of a DeprecationWarning?

Comment thread doc/topotools.rst
kmltools_module


.. seealso::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these do not exist yet. I am not entirely sure how these are determined TBH though as there are more in the rendered "see also" then is here.

Comment thread doc/topochanges.rst
but be aware of these warnings.

.. seealso::
- :ref:`topotools`

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of these do not exist yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants