Changeset 864

Timestamp:

12/13/11 16:35:58 (18 months ago)

Author:

jjr8

Message:

Added ROMS-CoSiNE to connectivity tool.

Files:

• MGET/Branches/Jason/PythonPackage/src/GeoEco/Connectivity/CoralReefConnectivity.py (modified) (9 diffs)

MGET/Branches/Jason/PythonPackage/src/GeoEco/Connectivity/CoralReefConnectivity.py

@@ -24 +24 @@
 from GeoEco.DataProducts.HYCOM import HYCOMGOMl0044D, _HYCOMGOMl004_LongDescription, HYCOMGLBa008Equatorial4D, _HYCOMGLBa008Equatorial_LongDescription
 from GeoEco.DataProducts.NOAA.OSCAR import OSCAR5DayThirdDegreeCurrents, _OSCAR_LongDescription
+from GeoEco.DataProducts.UMaineOMG import ROMSCoSiNE4D, _ROMS_CoSiNE_LongDescription
 from GeoEco.DynamicDocString import DynamicDocString
 from GeoEco.Internationalization import _
@@ -192 +193 @@
         # projection, extent, and cell size of the reef IDs raster.
 
-        cls._FinishLoadingCurrents(simulationDirectory, u'Aviso ' + product, u'Center', 86400, avisoCurrentsDirectory, u'setnull( inputRaster > 1000000 || inputRaster < -1000000, inputRaster / 100)')     # Use Map Algebra to Convert from cm/s to to m/s and mask bogus values introduced by ArcGIS
+        cls._FinishLoadingCurrents(simulationDirectory, scp, u'Aviso ' + product, u'Center', 86400, avisoCurrentsDirectory, u'setnull( inputRaster > 1000000 || inputRaster < -1000000, inputRaster / 100)')     # Use Map Algebra to Convert from cm/s to to m/s and mask bogus values introduced by ArcGIS
 
         # Return successfully.
@@ -227 +228 @@
         # projection, extent, and cell size of the reef IDs raster.
 
-        cls._FinishLoadingCurrents(simulationDirectory, u'OSCAR', u'Center', 6*86400, oscarCurrentsDirectory)
+        cls._FinishLoadingCurrents(simulationDirectory, scp, u'OSCAR', u'Center', 6*86400, oscarCurrentsDirectory)
 
         # Return successfully.
@@ -260 +261 @@
         # projection, extent, and cell size of the reef IDs raster.
 
-        cls._FinishLoadingCurrents(simulationDirectory, u'HYCOM GOMl0.04  ' + unicode(int(depth)) + u' m', u'Center', 86400, hycomCurrentsDirectory)
+        cls._FinishLoadingCurrents(simulationDirectory, scp, u'HYCOM GOMl0.04  ' + unicode(int(depth)) + u' m', u'Center', 86400, hycomCurrentsDirectory)
 
         # Return successfully.
@@ -293 +294 @@
         # projection, extent, and cell size of the reef IDs raster.
 
-        cls._FinishLoadingCurrents(simulationDirectory, u'HYCOM GLBa0.08 Equatorial ' + unicode(int(depth)) + u' m', u'Center', 86400, hycomCurrentsDirectory)
+        cls._FinishLoadingCurrents(simulationDirectory, scp, u'HYCOM GLBa0.08 Equatorial ' + unicode(int(depth)) + u' m', u'Center', 86400, hycomCurrentsDirectory)
 
         # Return successfully.
@@ -300 +301 @@
 
     @classmethod
-    def _FinishLoadingCurrents(cls, simulationDirectory, currentsProduct, currentsDateType, maxSecondsBetweenCurrentsImages, originalCurrentsDirectory, mapAlgebraExpression=None):
+    def LoadROMSCoSiNE4DCurrentsIntoSimulation(cls, simulationDirectory, startDate, endDate, depth=0., url=u'http://viz.clusters.umaine.edu:8080/thredds/dodsC/pacific/1991-2008', timeout=60, maxRetryTime=120, cacheDirectory=None):
+        cls.__doc__.Obj.ValidateMethodInvocation()
+
+        # Parse and validate the Simulation.ini file.
+
+        scp, crosses180, currentsLoaded, currentsProduct = cls._ReadCurrentsInfoFromSimulationINI(simulationDirectory)
+
+        # If the simulation already has currents loaded in it from a
+        # different product or depth, report an error.
+
+        if currentsLoaded and currentsProduct != u'ROMS-CoSiNE ' + unicode(int(depth)) + u' m':
+            Logger.RaiseException(ValueError(_(u'Cannot load %(prod1)s currents data into the simulation in directory %(dir)s because that simulation already has %(prod2)s currents data loaded into it. You can load additional %(prod2)s data, if you like, but to use %(prod1)s data, you must create a new simulation.') % {u'dir': simulationDirectory, u'prod1': u'ROMS-CoSiNE ' + unicode(int(depth)) + u' m', u'prod2': currentsProduct}))
+
+        # First, download and create ROMS-CoSiNE current rasters in a
+        # ROMS-CoSiNE-specific directory. These will have the
+        # ROMS-CoSiNE projection, extent, and cell size. We still need
+        # to project them to the simulation's projection, extent, and
+        # cell size.
+
+        romsCurrentsDirectory = os.path.join(simulationDirectory, 'OriginalROMSCurrents')
+        ROMSCoSiNE4D.CreateArcGISRasters(u'u', [depth], romsCurrentsDirectory, rasterNameExpressions=['%(VariableName)s', '%%Y', '%(VariableName)s%%Y%%j0000.img'], startDate=startDate, endDate=endDate, timeout=timeout, maxRetryTime=maxRetryTime, cacheDirectory=cacheDirectory)
+        ROMSCoSiNE4D.CreateArcGISRasters(u'v', [depth], romsCurrentsDirectory, rasterNameExpressions=['%(VariableName)s', '%%Y', '%(VariableName)s%%Y%%j0000.img'], startDate=startDate, endDate=endDate, timeout=timeout, maxRetryTime=maxRetryTime, cacheDirectory=cacheDirectory)
+
+        # Record in the Simulation.ini file that we downloaded some
+        # currents and then project, snap, and clip them to the
+        # projection, extent, and cell size of the reef IDs raster.
+
+        cls._FinishLoadingCurrents(simulationDirectory, scp, u'ROMS-CoSiNE ' + unicode(int(depth)) + u' m', u'Center', 73*3600, romsCurrentsDirectory)
+
+        # Return successfully.
+
+        return simulationDirectory
+
+    @classmethod
+    def _FinishLoadingCurrents(cls, simulationDirectory, scp, currentsProduct, currentsDateType, maxSecondsBetweenCurrentsImages, originalCurrentsDirectory, mapAlgebraExpression=None):
 
         # Write the Simulation.ini file, so that any new rasters
@@ -1195 +1230 @@
   center of the Gulf of Mexico.
 """),
-    arcGISDisplayName=_(u'Minimum depth'))
+    arcGISDisplayName=_(u'Depth'))
 
 CopyArgumentMetadata(HYCOMGOMl0044D.CreateArcGISRasters, u'timeout', CoralReefConnectivity.LoadHYCOMGOMl0044DCurrentsIntoSimulation, u'timeout')
@@ -1266 +1301 @@
   regions.
 """),
-    arcGISDisplayName=_(u'Minimum depth'))
+    arcGISDisplayName=_(u'Depth'))
 
 CopyArgumentMetadata(HYCOMGLBa008Equatorial4D.CreateArcGISRasters, u'extendYExtent', CoralReefConnectivity.LoadHYCOMGLBa0084DEquatorialCurrentsIntoSimulation, u'extendYExtent')
@@ -1274 +1309 @@
 
 CopyResultMetadata(CoralReefConnectivity.LoadAvisoGeostrophicCurrentsIntoSimulation, u'updatedSimulationDirectory', CoralReefConnectivity.LoadHYCOMGLBa0084DEquatorialCurrentsIntoSimulation, u'updatedSimulationDirectory')
+
+# Public method: CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation
+
+AddMethodMetadata(CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation,
+    shortDescription=_(u'Downloads Pacific ROMS-CoSiNE ocean currents into a coral reef connectivity simulation.'),
+    longDescription=_ROMS_CoSiNE_LongDescription % {u'name': 'tool'},
+    isExposedToPythonCallers=True,
+    isExposedByCOM=True,
+    isExposedAsArcGISTool=True,
+    arcGISDisplayName=_(u'Load Pacific ROMS-CoSiNE Currents Into Coral Reef Connectivity Simulation'),
+    arcGISToolCategory=_(u'Connectivity Analysis\\Coral Reef Larval Connectivity'),
+    dependencies=[ArcGISDependency(9, 2), ArcGISExtensionDependency(u'spatial'), PythonAggregatedModuleDependency('numpy')])
+
+CopyArgumentMetadata(CoralReefConnectivity.LoadAvisoGeostrophicCurrentsIntoSimulation, u'cls', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'cls')
+
+AddArgumentMetadata(CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'simulationDirectory',
+    typeMetadata=DirectoryTypeMetadata(mustExist=True),
+    description=_(
+u"""Existing coral reef connectivity simulation directory that should
+recieve the currents.
+
+The directory must have been created using the Create Coral Reef
+Connectivity Simulation tool.
+
+If you have already loaded Pacific ROMS-CoSiNE currents into the
+simulation, you can use this tool to add currents for an additional
+range of dates so long as they are for the same depth as the original
+currents. If you try to add a different currents product to the
+simulation (e.g. geostrophic currents from Aviso), or for a different
+depth, this tool will report an error.
+
+If you try to load data for a range of dates that have been already
+loaded into the simulation, the downloads for those dates will be
+skipped. There is no way to delete or overwrite the data that has
+already been loaded into the simulation. If you want to overwrite your
+existing data (e.g. you want to switch to using a different depth),
+you must create a new simulation."""),
+    arcGISDisplayName=_(u'Simulation directory to recieve ROMS-CoSiNE currents'))
+
+CopyArgumentMetadata(CoralReefConnectivity.LoadAvisoGeostrophicCurrentsIntoSimulation, u'startDate', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'startDate')
+CopyArgumentMetadata(CoralReefConnectivity.LoadAvisoGeostrophicCurrentsIntoSimulation, u'endDate', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'endDate')
+
+AddArgumentMetadata(CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'depth',
+    typeMetadata=FloatTypeMetadata(),
+    description=_(
+u"""Depth of currents layer to download.
+
+ROMS-CoSiNE uses a terrain-following vertical coordinate system
+designed to maximize the accuracy of the simulation in coastal areas
+and the open ocean simultaneously. There are 30 depth layers but their
+depths vary on a per-cell basis with latitude, longitude, and time.
+For example, coastal cells of the 10th depth layer might represent a
+depth of 10 meters, while cells in the open ocean might represent a
+depth of 200 meters. This tool interpolates a constant-depth layer
+from ROMS-CoSiNE's varying-depth layers using a linear interpolation
+algorithm.
+
+The depth 0 represents the surface. The sign of the depth coordinate
+is ignored (e.g. the values 10 and -10 are both interpreted as 10 m
+below the surface).
+
+This tool was designed primarily to study larvae that float at or near
+the surface. The default depth is 0. If you are studying larvae that
+stay submerged, you can choose a deeper depth, but be aware of two
+important points:
+
+* This tool assumes the larvae remain at that depth for the entire
+  simulation. It does not implement vertical migration or other
+  behaviors that might be appropriate for your species. A newer
+  version of this tool, to be released in 2012, will support vertical
+  migration.
+
+* Be aware that the spatial extent of available currents data will
+  shrink as depth increases. For example, if you choose a deep depth
+  such as 250 m, there will be no data available for regions close to
+  shore because the ocean is typically shallower than 250 m in those
+  regions.
+"""),
+    arcGISDisplayName=_(u'Depth'))
+
+CopyArgumentMetadata(ROMSCoSiNE4D.CreateArcGISRasters, u'url', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'url')
+CopyArgumentMetadata(ROMSCoSiNE4D.CreateArcGISRasters, u'timeout', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'timeout')
+CopyArgumentMetadata(ROMSCoSiNE4D.CreateArcGISRasters, u'maxRetryTime', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'maxRetryTime')
+CopyArgumentMetadata(ROMSCoSiNE4D.CreateArcGISRasters, u'cacheDirectory', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'cacheDirectory')
+
+CopyResultMetadata(CoralReefConnectivity.LoadAvisoGeostrophicCurrentsIntoSimulation, u'updatedSimulationDirectory', CoralReefConnectivity.LoadROMSCoSiNE4DCurrentsIntoSimulation, u'updatedSimulationDirectory')
 
 # Public method: CoralReefConnectivity.RunSimulation