Basic Installation Instructions

[gemmaellen]

Hello! I am trying to figure out how to install the package and run some examples. There is a wide variety of documentation out there, but it is difficult to find a single set of simple instructions that will allow me to install this package and run an example.

The "Quick start" instructions on the front page of this repository say to do the following:

git clone https://github.com/ketch/nodepy.git
cd clawpack
git submodule init
git submodule update
pip install -e .
cd pyclaw/examples/euler_2d
python shock_bubble_interaction.py iplot=1

This is confusing, because the first line is asking me to clone the repository for nodepy, which is an ODE solver. It is not going to create a folder called clawpack, nor does it have any sort of folder for clawpack inside it.

Giving up on those instructions, I instead went to the documentation here: http://www.clawpack.org/installing_pip.html# . The command pip install --user clawpack did not work, but the more complicated instructions for "install all packages" did. So at this point, in theory, I have Clawpack installed on my machine.

Having got that far, I went back to the instructions above, cloned this pyclaw repository (instead of nodepy), and tried to run the final two commands:

cd pyclaw/examples/euler_2d
python shock_bubble_interaction.py iplot=1

This gave me the following output:

2022-03-18 12:06:35,443 INFO CLAW: Solution 0 computed for time t=0.000000
ValueError: too many axes: 3 (effrank=2), expected rank=1

followed by a longer traceback.

Is there a working example out there that I can use to check my installation? And could the "Quick start" instructions on the front page be improved?

[gemmaellen]

For what it's worth, some of my issues are the same ones detailed here: https://github.com/clawpack/clawpack/issues/203

In particular, I have been able to resolve my problem by installing via conda -- many thanks to ngam for setting that up!

It might still be useful to change the readme for PyClaw so that it sends people to the main Clawpack page to get started.

[ketch]

@gemmaellen Thanks for catching the typo (a copy paste error from a year ago; I maintain multiple packages). And sorry for the frustration it caused.

[ketch]

I've removed the faulty instructions and just set the README to point to the main Clawpack docs in #696.