init test file

Signed-off-by: Franklin Zhang <franklinzhang@foxmail.com>

Author: franklinzhanggis

README.md

@@ -10,15 +10,15 @@ Software architecture description.
 
 ## Installation
 
-Before install it, please ensure your PC has Python 3.7 and pip already.
+Before install it, please ensure your PC has Python 3.7 and pip already. There are two methods to install package.
 
 ### 1. Download
 Download [pip package](standard-demo/bmi/release/BMI-OpenGMS-Engine-0.1.0.tar.gz)
 
 ### 2. Install pip package
 Open cmd window in Windows or shell in Linux or MacOS, pip.
 
-Type `pip install bmi-opengms-engine`
+Type `pip3 install bmi-opengms-engine`
 
 ## Usage
 
@@ -70,7 +70,24 @@ Type `pip install bmi-opengms-engine`
 * Return : Void
 The package will be generation in the same folder with BMI component
 
-the package can be deployed in [the wrapper system of OpenGMS (GeoModelServiceContainer)]()
+the package can be deployed in [the wrapper system of OpenGMS (GeoModelServiceContainer)](https://github.com/franklinzhanggis/wrappersystem)
+
+### Demo
+
+#### Demo 1 - HeatMap
+
+``` python
+
+def test_for_bmi_opengms_engine():
+    dirname = os.path.dirname(__file__)
+    BMIOpenGMSEngine.convertBMI2OpenGMS(dirname + "/heat", "BmiHeat", dirname + "/data/bmi_heat_map_supplement.json")
+
+```
+
+
+
+
+HeatMap is the CSDMS BMI offical demo 
 
 ## Contributors
 ### Founders/Designers

test/bmi/__init__.py

@@ -0,0 +1,5 @@
+"""The Basic Model Interface."""
+from .bmi import Bmi
+
+
+__all__ = ['Bmi']

test/bmi/base.py

@@ -0,0 +1,115 @@
+#! /usr/bin/env python
+"""Interface to the basic control functions of a model."""
+
+
+class BmiBase(object):
+
+    """Functions that control model execution.
+
+    These BMI functions are critical to plug-and-play modeling because they
+    give a calling component fine-grained control over the model execution.
+    """
+
+    def initialize(self, filename):
+        """Perform startup tasks for the model.
+
+        Perform all tasks that take place before entering the model's time
+        loop, including opening files and initializing the model state. Model
+        inputs are read from a text-based configuration file, specified by
+        `filename`.
+
+        Parameters
+        ----------
+        filename : str, optional
+          The path to the model configuration file.
+
+        Notes
+        -----
+        Models should be refactored, if necessary, to use a
+        configuration file. CSDMS does not impose any constraint on
+        how configuration files are formatted, although YAML is
+        recommended. A template of a model's configuration file
+        with placeholder values is used by the BMI.
+
+        .. code-block:: c
+
+            /* C */
+            int initialize(void *self, char * filename);
+        """
+        pass
+
+    def update(self):
+        """Advance model state by one time step.
+
+        Perform all tasks that take place within one pass through the model's
+        time loop. This typically includes incrementing all of the model's
+        state variables. If the model's state variables don't change in time,
+        then they can be computed by the :func:`initialize` method and this
+        method can return with no action.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int update(void *self);
+        """
+        pass
+
+    def update_until(self, time):
+        """Advance model state until the given time.
+
+        Parameters
+        ----------
+        time : float
+          A model time value.
+
+        See Also
+        --------
+        update
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int update_until(void *self, double time);
+        """
+        pass
+
+    def update_frac(self, time_frac):
+        """Advance model state by a fraction of a time step.
+
+        Parameters
+        ----------
+        time_frac : float
+          A fraction of a model time step value.
+
+        See Also
+        --------
+        update
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int update_frac(void *self, double time_frac);
+        """
+        pass
+
+    def finalize(self):
+        """Perform tear-down tasks for the model.
+
+        Perform all tasks that take place after exiting the model's time
+        loop. This typically includes deallocating memory, closing files and
+        printing reports.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int finalize(void *self);
+        """
+        pass

test/bmi/bmi.py

@@ -0,0 +1,26 @@
+#! /usr/bin/env python
+"""The complete Basic Model Interface."""
+
+
+from .base import BmiBase
+from .info import BmiInfo
+from .time import BmiTime
+from .vars import BmiVars
+from .getter_setter import BmiGetter, BmiSetter
+from .grid_rectilinear import BmiGridRectilinear
+from .grid_uniform_rectilinear import BmiGridUniformRectilinear
+from .grid_structured_quad import BmiGridStructuredQuad
+from .grid_unstructured import BmiGridUnstructured
+
+
+class Bmi(BmiBase, BmiInfo, BmiTime, BmiVars, BmiGetter, BmiSetter,
+          BmiGridRectilinear, BmiGridUniformRectilinear, BmiGridStructuredQuad,
+          BmiGridUnstructured):
+
+    """The complete Basic Model Interface.
+
+    Defines an interface for converting a standalone model into an
+    integrated modeling framework component.
+    """
+
+    pass

test/bmi/getter_setter.py

@@ -0,0 +1,144 @@
+#! /usr/bin/env python
+"""Interface for getting and setting a model's internal variables."""
+
+
+class BmiGetter(object):
+
+    """Get values from a component.
+
+    Methods that get variables from a model's state. Often a model's state
+    variables are changing with each time step, so getters are called to get
+    current values.
+    """
+
+    def get_value(self, var_name):
+        """Get a copy of values of the given variable.
+
+        This is a getter for the model, used to access the model's
+        current state. It returns a *copy* of a model variable, with
+        the return type, size and rank dependent on the variable.
+
+        Parameters
+        ----------
+        var_name : str
+          An input or output variable name, a CSDMS Standard Name.
+
+        Returns
+        -------
+        array_like
+          The value of a model variable.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int get_value(void * self, const char * var_name, void * buffer);
+        """
+        pass
+
+    def get_value_ref(self, var_name):
+        """Get a reference to values of the given variable.
+
+        This is a getter for the model, used to access the model's
+        current state. It returns a reference to a model variable,
+        with the return type, size and rank dependent on the variable.
+
+        Parameters
+        ----------
+        var_name : str
+          An input or output variable name, a CSDMS Standard Name.
+
+        Returns
+        -------
+        array_like
+          A reference to a model variable.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int get_value_ref(void * self, const char * var_name,
+                              void ** buffer);
+        """
+        pass
+
+    def get_value_at_indices(self, var_name, indices):
+        """Get values at particular indices.
+
+        Parameters
+        ----------
+        var_name : str
+          An input or output variable name, a CSDMS Standard Name.
+        indices : array_like
+          The indices into the variable array.
+
+        Returns
+        -------
+        array_like
+            Value of the model variable at the given location.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int get_value_at_indices(void * self, const char * var_name,
+                                     void * buffer, int * indices, int len);
+        """
+        pass
+
+
+class BmiSetter(object):
+
+    """Set values into a component.
+
+    Methods that set variables of a model's state.
+    """
+
+    def set_value(self, var_name, src):
+        """Specify a new value for a model variable.
+
+        This is the setter for the model, used to change the model's
+        current state. It accepts, through *src*, a new value for a
+        model variable, with the type, size and rank of *src*
+        dependent on the variable.
+
+        Parameters
+        ----------
+        var_name : str
+          An input or output variable name, a CSDMS Standard Name.
+        src : array_like
+          The new value for the specified variable.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int set_value(void * self, const char * var_name, void * src);
+        """
+        pass
+
+    def set_value_at_indices(self, var_name, indices, src):
+        """Specify a new value for a model variable at particular indices.
+
+        Parameters
+        ----------
+        var_name : str
+          An input or output variable name, a CSDMS Standard Name.
+        indices : array_like
+          The indices into the variable array.
+        src : array_like
+          The new value for the specified variable.
+
+        Notes
+        -----
+        .. code-block:: c
+
+            /* C */
+            int set_value_at_indices(void * self, const char * var_name,
+                                     int * indices, int len, void * src);
+        """
+        pass