I7 parameters

notebooks/demo_parameters.ipynb

@@ -0,0 +1,117 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from birdy import WPSClient\n",
+    "from pkg_resources import resource_filename\n",
+    "\n",
+    "import requests"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os \n",
+    "while os.path.basename(os.getcwd()) != \"osprey\": # Ensure current directory is always 'osprey'\n",
+    "    os.chdir('../')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Set up wps application\n",
+    "url = 'http://localhost:5002/wps'\n",
+    "osprey = WPSClient(url=url)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "osprey?"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Check info on `parameters` process\n",
+    "osprey.parameters?"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "/home/slim/osprey/tests/data/sample_parameter_config.cfg\n"
+     ]
+    }
+   ],
+   "source": [
+    "cfg_file = resource_filename(\"tests\", \"data/sample_parameter_config.cfg\")\n",
+    "print(cfg_file)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# run parameters\n",
+    "output = osprey.parameters(\n",
+    "    config = cfg_file\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "output.get()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.9"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

osprey/processes/__init__.py

@@ -1,5 +1,7 @@
 from .wps_say_hello import SayHello
+from .wps_parameters import Parameters
 
 processes = [
     SayHello(),
+    Parameters(),
 ]

osprey/processes/wps_parameters.py

@@ -0,0 +1,130 @@
+# Processor imports
+from pywps import (
+    Process,
+    LiteralInput,
+)
+from pywps.app.Common import Metadata
+
+# Tool imports
+from rvic.parameters import parameters
+from rvic.core.config import read_config
+from wps_tools.utils import (
+    collect_output_files,
+    log_handler,
+)
+from wps_tools.io import (
+    log_level,
+    nc_output,
+)
+
+# Library imports
+import logging
+import os
+
+pywps_logger = logging.getLogger("PYWPS")
+
+
+class Parameters(Process):
+    def __init__(self):
+        self.status_percentage_steps = {
+            "start": 0,
+            "dry_run": 5,
+            "process": 10,
+            "collect_files": 90,
+            "build_output": 95,
+            "complete": 100,
+        }
+        inputs = [
+            LiteralInput(
+                "config",
+                "Configuration",
+                abstract="Path to input configuration file or input dictionary",
+                data_type="string",
+            ),
+            LiteralInput(
+                "np",
+                "numofproc",
+                default=1,
+                abstract="Number of processors used to run job",
+                data_type="integer",
+            ),
+            LiteralInput(
+                "version",
+                "Version",
+                default=True,
+                abstract="Return RVIC version string",
+                data_type="boolean",
+            ),
+        ]
+        outputs = [
+            nc_output,
+        ]
+
+        super(Parameters, self).__init__(
+            self._handler,
+            identifier="parameters",
+            title="Parameters",
+            abstract="Develop impulse response functions using inputs from a "
+            "configuration file or dictionary",
+            metadata=[
+                Metadata("NetCDF processing"),
+                Metadata("Climate Data Operations"),
+            ],
+            inputs=inputs,
+            outputs=outputs,
+            store_supported=True,
+            status_supported=True,
+        )
+
+    def collect_args(self, request):
+        config = request.inputs["config"][0].data
+        np = request.inputs["np"][0].data
+        return (config_file, np)
+
+    def get_outfile(self, config):
+        if isinstance(config, dict):
+            config_dict = config
+        else:
+            config_dict = read_config(config)
+        outdir = os.path.join(config_dict["OPTIONS"]["CASE_DIR"], "params")
+        (param_file,) = collect_output_files("rvic", outdir)
+        return os.path.join(outdir, param_file)
+
+    def _handler(self, request, response):
+        if request.inputs["version"][0].data:
+            from rvic import version
+
+            pywps_logger.info(version.short_version)
+
+        (config, np) = self.collect_args(request)
+        log_handler(
+            self, response, "Starting Process", process_step="start", level=loglevel
+        )
+        if config[0] != "{":
+            if not os.path.isfile(config):
+                raise IOError("config_file: {0} does not " "exist".format(config))
+        else:  # configuration is dictionary of inputs
+            config = eval(config)
+
+        log_handler(
+            self,
+            response,
+            "Creating parameters",
+            process_step="process",
+            level=loglevel,
+        )
+        parameters(config, np)
+
+        log_handler(
+            self,
+            response,
+            "Building final output",
+            process_step="build_output",
+            level=loglevel,
+        )
+        response.outputs["output"].file = self.get_outfile(config)
+
+        log_handler(
+            self, response, "Process Complete", process_step="complete", level=loglevel,
+        )
+        return response

requirements.txt

@@ -2,3 +2,4 @@ pywps>=4.2
 jinja2
 click
 psutil
+rvic==1.1.0post1

requirements_dev.txt

@@ -12,3 +12,10 @@ twine
 cruft
 # Changing dependencies above this comment will create merge conflicts when updating the cookiecutter template with cruft. Add extra requirements below this line.
 black==19.10b0
+
+# notebook requirements
+jupyterlab
+ipywidgets
+nodejs
+birdhouse-birdy
+beautifulsoup4