-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updates to install directions and for v5.8.1, doc@90790be
- Loading branch information
Showing
1,701 changed files
with
4,737 additions
and
2,697 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,112 +8,44 @@ Installing Clawpack | |
|
|
||
| See also: | ||
|
|
||
| * :ref:`clawpack_packages` | ||
| * :ref:`releases` | ||
| * :ref:`trouble_installation` | ||
| - :ref:`releases` | ||
| - :ref:`docker_image` as an alternative to installing | ||
|
|
||
| **Prerequisites:** Before installing, check that you have the :ref:`prereqs`. | ||
|
|
||
|
|
||
| .. _installing_pipintro: | ||
|
|
||
| pip install | ||
| ----------- | ||
|
|
||
| The recommended approach is to use `pip install`. | ||
| It is also possible to have multiple versions of Clawpack installed and | ||
| switch between them (i.e., modify your Python path) using `pip`. | ||
| (see :ref:`installing_pip`) | ||
| If you plan to do this, or if you also wish to directly use the Fortran | ||
| variants of Clawpack (classic, AMRClaw, and/or GeoClaw), then we recommend | ||
| using the following version of the `pip install` command | ||
| **(you might want to first read the notes below to see if you | ||
| want to change anything in this command)**:: | ||
|
|
||
| pip install --src=$HOME/clawpack_src --user -e \ | ||
| git+https://github.com/clawpack/[email protected]#egg=clawpack-v5.8.0 | ||
|
|
||
| This will download Clawpack (via a git clone) into the directory | ||
| `$HOME/clawpack_src/clawpack-v5.8.0`. The top | ||
| installation directory can be changed by modifying the ``--src`` target | ||
| (or omit this part to put it in your current working directory). | ||
| If you have already downloaded Clawpack via a different mechanism then | ||
| see :ref:`pip_switch_version` rather than using the above command. | ||
|
|
||
|
|
||
| See :ref:`clawpack_components` for a list of what's included in this top | ||
| level directory. | ||
|
|
||
| **Note:** Using pip to install will also check some python | ||
| :ref:`prereqs` and may update these on your system, and will use f2py to | ||
| convert Fortran Riemann solvers to Python versions. See | ||
| :ref:`installing_options` if you want more control. | ||
|
|
||
| The ``--user`` flag is necessary if you are installing on a shared computer | ||
| where you do not have root access. If you do have root access and want it | ||
| to be available to all users, you can omit this flag. | ||
| **Register:** Please `register <http://depts.washington.edu/clawpack/register/index.html>`_ | ||
| if you have not already done so. This is very useful in helping | ||
| us track the extent of usage, and important to the :ref:`funding` agencies | ||
| who support this work. | ||
|
|
||
| The ``-e`` flag makes it an "editable" install, leaving the source code in | ||
| place and allowing you to modify it if desired. | ||
| (Otherwise, by default, pip would move the python code to some | ||
| `site-packages` directory and delete everything else.) | ||
|
|
||
| In order to use the Fortran codes within Clawpack, | ||
| you should then set the environment | ||
| variable `CLAW` to point to the `clawpack-v5.8.0` directory within | ||
| the installation directory `$HOME/clawpack_src`, and `FC` to point | ||
| to the desired Fortran compiler, e.g. in the bash shell:: | ||
|
|
||
| export CLAW=$HOME/clawpack_src/clawpack-v5.8.0 | ||
| export FC=gfortran | ||
|
|
||
| See :ref:`setenv` for more information. | ||
|
|
||
| For more discussion of `pip` installation, and troubleshooting hints, see | ||
| :ref:`installing_pip`. | ||
|
|
||
|
|
||
| .. _installing_options: | ||
|
|
||
| Other Installation Options | ||
| ===================================== | ||
|
|
||
| In general, *installing* Clawpack requires downloading some version | ||
| and then setting | ||
| paths so that Python import statements (and possibly Fortran Makefiles) find | ||
| the desired version. Switching between versions already on your computer | ||
| simply requires resetting paths. For hints and troubleshooting, see: | ||
| **Prerequisites:** Before installing, check that you have the :ref:`prereqs`. | ||
|
|
||
| **Please see** | ||
|
|
||
| - :ref:`setenv` | ||
| - :ref:`python_path` | ||
| - :ref:`installing_pip` | ||
| - :ref:`clawpack_packages` | ||
|
|
||
| Rather than using `pip`, there are several other options for using | ||
| Clawpack that may be useful depending on your needs. These are summarized | ||
| in :ref:`installing_more_options`, including: | ||
| before installing, particularly if you are not sure whether you will | ||
| be using the Fortran versions of the PDE solvers | ||
| (:ref:`contents_fortcodes`) or the :ref:`pyclaw` version of the PDE solvers. | ||
|
|
||
| - :ref:`installing_tarfile` | ||
| - :ref:`install_dev` | ||
| - :ref:`installing_conda` | ||
| - :ref:`installing_docker` | ||
| - :ref:`installing_aws` | ||
| - :ref:`install_pyclaw_parallel` | ||
| **Then choose the best installation option** for your needs from this list: | ||
|
|
||
| **Python path:** | ||
| If you download a tarfile or use `git clone` to download a version, you can | ||
| still use `pip install` to set the Python path appropriately. | ||
| See :ref:`installing_pip` for details. | ||
| - If you **only** plan to use PyClaw to solve the PDEs and Visclaw for plotting, | ||
| we suggest | ||
|
|
||
| - :ref:`install_quick_pyclaw`. | ||
|
|
||
| - If you **only** plan to use the Fortran variants of Clawpack | ||
| (:ref:`contents_fortcodes`) for solving the PDEs, together with | ||
| Visclaw for plotting and other Python tools (e.g. from geoclaw or clawutil), | ||
| then we suggest | ||
|
|
||
| - :ref:`installing_fortcodes`. | ||
|
|
||
| - If you are a power user who plans to use both PyClaw and the Fortran variants | ||
| for solving PDEs, we recommend | ||
|
|
||
| - :ref:`install_quick_all`. | ||
|
|
||
| If you are *not* using `pip` to set paths, then you will need to set | ||
| the `PYTHONPATH` | ||
| environment variable to point to a particular version of Clawpack, | ||
| but this is `not recommended <https://orbifold.xyz/pythonpath.html>`_. | ||
| See :ref:`python_path` for more details and tips on sorting out your path. | ||
|
|
||
| **Components:** | ||
| See :ref:`clawpack_components` for a list of what is generally included | ||
| under the top level `clawpack` directory when using any of the approaches below. | ||
| (And what is not included, e.g. the :ref:`apps`.) | ||
|
|
||
|
|
||
| Next steps: | ||
|
|
@@ -124,4 +56,6 @@ started: | |
|
|
||
| - :ref:`first_run_pyclaw` | ||
| - :ref:`first_run_fortran` | ||
| - :ref:`trouble_installation` | ||
|
|
||
|
|
||
Oops, something went wrong.