PRMS-Python
diff --git a/‎prms_python/prms_python.py‎
Lines changed: 77 additions & 0 deletions b/‎prms_python/prms_python.py‎
Lines changed: 77 additions & 0 deletions
diff --git a/‎prms_python/prms_run.py‎
Lines changed: 0 additions & 125 deletions b/‎prms_python/prms_run.py‎
Lines changed: 0 additions & 125 deletions
diff --git a/‎test/data/control‎ b/‎test/data/control‎
diff --git a/‎test/data/data‎ b/‎test/data/data‎
diff --git a/‎test/data/parameter‎ b/‎test/data/parameter‎
diff --git a/‎test/test_prms_python.py‎
Lines changed: 49 additions & 0 deletions b/‎test/test_prms_python.py‎
Lines changed: 49 additions & 0 deletions
@@ -0,0 +1,77 @@
+'''
+PRMS-Python: Powerful, sane tools for manipulating PRMS input data to create
+new scenarios or parameterizations for sensitivity analysis, scenario
+modeling, or whatever other uses this might have.
+
+The fundamental process in scenario development is to modify some "base"
+starting data to create some "scenario" data. No matter what data we're using,
+once it's ready, we run a PRMS "simulation" on that data.
+
+This module presents a Simulation and Scenario class, where each tracks
+relevant provenance information and input files to facilitate better
+data management techniques to streamline later analyses.
+'''
+import os
+import subprocess
+
+
+class Simulation(object):
+    """
+    Simulation class for tracking the inputs and outputs of a single
+    PRMS simulation.
+    """
+    def __init__(self, simulation_dir):
+        """
+        Create a new Simulation object from a simulation directory. Check that
+        all required PRMS inputs (control, parameters, data) exist in the
+        expected locations.
+
+        Also parses the control file to make sure that the data and parameter
+        file specified match the ones in the simulation_dir
+
+        Arguments:
+            simulation_dir (str): location of control, parameter, and data
+                files for the Simulation
+        """
+        sd = simulation_dir
+
+        self.control = os.path.join(sd, 'control')
+        self.parameter = os.path.join(sd, 'parameter')
+        self.data = os.path.join(sd, 'data')
+
+        if not os.path.exists(self.control):
+            raise RuntimeError('Control file missing from ' + sd)
+
+        if not os.path.exists(self.parameter):
+            raise RuntimeError('Parameter file missing from ' + sd)
+
+        if not os.path.exists(self.data):
+            raise RuntimeError('Data file missing from ' + sd)
+
+        self.has_run = False
+
+    def run(self):
+
+        prms_finished = False
+        while not prms_finished:
+
+            p = subprocess.Popen(
+                'prms ' + self.control, shell=True,
+                stdout=subprocess.PIPE, stderr=subprocess.PIPE
+            )
+
+            p.communicate()
+
+            poll = p.poll()
+            prms_finished = poll != 0
+
+        self.has_run = True
+
+    def visualize(self):
+
+        if not self.has_run:
+            raise RuntimeError(
+                'You must first run the model before performing visualizations'
+            )
+
+        return None
@@ -0,0 +1,49 @@
+import os
+import shutil
+import unittest
+
+
+class TestScenarioSimulations(unittest.TestCase):
+    """Simulations should take a base directory and return a simulation directory"""
+
+    def setUp(self):
+
+        self.test_data_dir = os.path.join('test', 'data', 'tmp')
+
+        if os.path.exists(self.test_data_dir):
+            shutil.rmtree(self.test_data_dir)
+
+        os.mkdir(self.test_data_dir)
+
+        td = self.test_data_dir
+
+        self.starting_dirs = [
+            os.path.join(td, 'basedir1'), os.path.join(td, 'basedir2')
+        ]
+
+        self.simulation_dirs = [
+            os.path.join(td, 'simdir1'), os.path.join(td, 'simdir2')
+        ]
+
+    def tearDown(self):
+        """docstring for tearDown"""
+
+        shutil.rmtree(self.test_data_dir)
+
+    def test_create_scenario(self):
+        """a simulation setup should create a simulation directory"""
+        assert False
+
+    def test_create_many_scenarios(self):
+        """create_many_simulations should create many corresponding simulation directories"""
+        assert False
+
+    def test_apply_funcs(self):
+        """parameter and data file modification access should work as expected"""
+        assert False
+
+    def test_simulation(self):
+        assert False
+
+    def test_simulate_many(self):
+        assert False