-
Notifications
You must be signed in to change notification settings - Fork 62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document solver constants and indices, making values available in Python scripts #77
Conversation
One example of how this can be used is here: clawpack/pyclaw#454. |
One thing that we should discuss before/if this gets merged is what names to use for the conserved quantity (and auxiliary variable) indices. I have mainly used long names rather than mathematical symbols (e.g., "density" instead of "rho"). |
I think keeping the full names rather than the commonly used mathematical symbol names is a good idea for readability and new users. There's nothing more frustrating than taking a look at a new area and finding mathematical symbols everywhere that mean something to the experts but not to a newbie. |
You have segfaulted nosetests, I think there should be an award for such things. |
The strange thing is that it segfaulted after nosetests completed with all tests passing. I can't see why it could be failing since
I'm getting inconsistent results (different errors) when I rerun on Travis. Any ideas? |
The comments in each normal Riemann solver now include: - The number of waves - The number of conserved quantities - The number of auxiliary variables - The names and indices of the conserved quantities and variables A short script extracts these values and writes them to Python modules so they can be imported and used in Python scripts. Ideally, this would be implemented without the extra Python modules by putting the Riemann solvers in modules and using module data. This is a simple solution that doesn't require any drastic changes.
e2ecf93
to
5d7836a
Compare
Now it is passing (after I made the tests run from pyclaw/examples). I'd like to merge this (and use it in most of the PyClaw examples) if there are no objections. |
Sounds good to me. I can merge. |
Document solver constants and indices, making values available in Python scripts
Add surge related data objects to default GeoClaw object
The comments in each normal Riemann solver now include:
A short script extracts these values and writes them to Python modules
so they can be imported and used in Python scripts.
Ideally, this would be implemented without the extra Python modules
by putting the Riemann solvers in modules and using module data.
This is a simple solution that doesn't require any drastic changes.