#############################################################################
README H2020 EoCoE, ParFlow
#############################################################################

:Author: Wendy SHARPLES (WSh), Lukas POORTHUIS (LPo), Klaus GOERGEN (KGo)
:Contact: Wendy Sharples: w.sharples@fz-juelich.de (WP4), 
Ilya Zhukov: i.zhukov@fz-juelich.de (WP1)   
:Additional Contacts: l.poorthuis@fz-juelich.de, k.goergen@fz-juelich.de
:Web site: http://www.hpsc-terrsys.de/simlab
:Version: 2016-03-30

**********************
Content and motivation
**********************

This is a self-contained archive with a two common land model test cases, a precipitation
minus evaprotranspiration test case and several idealized test cases of the ParFlow
hydrologic model in the context of the H2020 EoCoE project.

*********
Structure
*********

- ````: implementation
- ``driver\``: Base JUBE2 run-control/benchmarking xml scripts
- ``model\``: ParFlow models and associated files
- ``custom\``: Customized job parameters as xml scripts
- ``jubeRun_script.py``: Python script to run a customised job in the JUBE2 environment
  using the driver and custom xml scripts
- ``jubeResult_script.py``: Python script to run jube analysis commands on a job
- ``juqueen_files\``: Files needed for compilation and installation of ParFlow on JUQUEEN
- ``jureca_files\``: Files needed for compilation and installation of ParFlow on JURECA
- ``funcs.py``: Contains Python calculations utilized by JUBE
- ``doc\``: Contains the JUBE script documentation and ParFlow manual
- ``profiler_data\``: Contains files that are needed to run the respective
  profiling tools
- ``src\``: Contains zipped and tarred versions of ParFlow
- ``templates\``: Contains template parameters as xml scripts for both JURECA and JUQUEEN 
  with regards to compilation of ParFlow and running ParFlow models on each machine, with 
  optional profiling instrumentation

**************************
HPC system and environment
**************************

- JSC/JURECA
- JSC/JUQUEEN

******
Status
******

Ready to use.

******************
Information / URLs
******************

- `ParFlow src <http://inside.mines.edu/~rmaxwell/parflow.rXXX.tar.gz>`_:

  * Versions: r693 (stable), r711 and r743
 
- `ParFlow homepage <http://inside.mines.edu/~rmaxwell/maxwell_software.shtml>`_
- `ParFlow Blog <http://parflow.blogspot.de/>`_
- Official ParFlow manual PDF under ``./doc``
- Recent publication:
  Maxwell, R. M., L. E. Condon, and S. J. Kollet (2015), A high-resolution
  simulation of groundwater and surface water over most of the continental
  US with the integrated hydrologic model ParFlow v3, Geosci. Model Dev.,
  8(3), 923–937, doi:10.5194/gmd-8-923-2015.

*********************
Cookbook/Instructions
*********************

See the ``doc/cookbook.rst`` file for a full usage documentation.

********
Linkages
********

- NIC SBDA project of SimLab TerrSys

****************
Copywrite Notice
****************

Copyright (C) 2016  Wendy Sharples, Lukas Poorthuis, Klaus Goergen

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

.. |done| unicode:: U+2713
