Merge pull request #88 from baagaard-usgs/feature-csgeo-local

Add CSGeoLocal for specifying local, rotated geographic coordinate systems

Author: baagaard-usgs

CHANGES.md

@@ -1,6 +1,7 @@
 ## Version 3.1.0 (TBD)
 
 * Add `AnalyticDB` for a spatial database composed of analytic functions.
+* Add `CSGeoLocal` for local rotated geographic coordinate systems.
 * Switch from CppUnit to Catch2 for C++ testing framework.
 * Bugfixes
   - Update spatial database validateParameters() to use correct data member (self.label -> self.description).

docs/tikz-styles/figcolors.tex

@@ -0,0 +1,22 @@
+\definecolor{yellow}{rgb}{1.0, 1.0, 0.45} % 255/255/115
+\definecolor{dkyellow}{rgb}{0.9, 0.9, 0.0} % % 230/230/0
+
+\definecolor{ltorange}{rgb}{1.0, 0.74, 0.41} % 255/188/105
+\definecolor{orange}{rgb}{0.96, 0.50, 0.0} % 246/127/0
+
+\definecolor{ltred}{rgb}{1.0, 0.25, 0.25} % 255/64/64
+\definecolor{red}{rgb}{0.79, 0.00, 0.01} % 201/0/3
+
+\definecolor{ltpurple}{rgb}{0.81, 0.57, 1.00} % 206/145/255
+\definecolor{purple}{rgb}{0.38, 0.00, 0.68} % 97/1/175
+
+\definecolor{ltblue}{rgb}{0.2, 0.73, 1.0} % 51/187/255
+\definecolor{blue}{rgb}{0.12, 0.43, 0.59} % 30/110/150
+
+\definecolor{ltltgreen}{rgb}{0.7, 1.00, 0.7} % 96/204/14
+\definecolor{ltgreen}{rgb}{0.37, 0.80, 0.05} % 96/204/14
+\definecolor{green}{rgb}{0.23, 0.49, 0.03} % 59/125/8
+  
+\definecolor{dkslate}{rgb}{0.18, 0.21, 0.28} % 47/53/72
+\definecolor{mdslate}{rgb}{0.45, 0.50, 0.68} % 114/127/173
+\definecolor{ltslate}{rgb}{0.85, 0.88, 0.95} % 216/225/229

docs/user/components/geocoords/CSGeoLocal.md

@@ -0,0 +1,42 @@
+# CSGeoLocal
+
+% WARNING: Do not edit; this is a generated file!
+:Full name: `spatialdata.geocoords.CSGeoLocal`
+:Journal name: `csgeoLocal`
+
+Python manager for local, rotated geographic coordinate systems.
+
+Implements `CSGeo`.
+
+## Pyre Properties
+
+* `crs_string`=\<str\>: String specifying coordinate system (PROJ parameters, EPSG, or WKT). Default is WGS84.
+  - **default value**: 'EPSG:4326'
+  - **current value**: 'EPSG:4326', from {default}
+* `origin_x`=\<float\>: X coordinate of local origin.
+  - **default value**: 0.0
+  - **current value**: 0.0, from {default}
+* `origin_y`=\<float\>: Y coordinate of local origin.
+  - **default value**: 0.0
+  - **current value**: 0.0, from {default}
+* `space_dim`=\<int\>: Number of dimensions for coordinate system.
+  - **default value**: 3
+  - **current value**: 3, from {default}
+* `y_azimuth`=\<float\>: Azimuth (degrees) of local y axis.
+  - **default value**: 0.0
+  - **current value**: 0.0, from {default}
+
+## Example
+
+Example of setting `CSGeoLocal` Pyre properties and facilities in a parameter file.
+
+:::{code-block} cfg
+[coordsys]
+# Local, rotated UTM Zone 10 coordinate system
+crs_string = EPSG:29610
+space_dim = 2
+origin_x = 300000.0
+origin_y = 4000000.0
+y_azimuth = -25.0
+:::
+

docs/user/components/geocoords/index.md

@@ -8,5 +8,6 @@ maxdepth: 1
 ---
 CSCart.md
 CSGeo.md
+CSGeoLocal.md
 CoordSys.md
 :::

docs/user/components/spatialdb/AnalyticDB.md

@@ -4,7 +4,7 @@
 :Full name: `spatialdata.spatialdb.AnalyticDB`
 :Journal name: `AnalyticDB`
 
-Spatial database with uniform values.
+Spatial database composed of analytic functions.
 
 Implements `SpatialDB`.
 
@@ -19,7 +19,7 @@ Implements `SpatialDB`.
 * `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x1061fcc10>
+  - **validator**: <function validateDescription at 0x102e94dc0>
 * `expressions`=\<list\>: Analytical expressions for values in spatial database.
   - **default value**: []
   - **current value**: [], from {default}
@@ -40,5 +40,7 @@ description = Uniform material properties
 values = [density, vp, vs]
 units = [kg/m**3, km/s, m/s]
 expressions = [2.0*x-y, 2.0x*x/(y*y), -2.0*z]
+cs = spatialdata.geocoords.CSCart
+cs.space_dim = 3
 :::
 

docs/user/components/spatialdb/CompositeDB.md

@@ -23,7 +23,7 @@ Implements `SpatialDB`.
 * `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x112cb1dc0>
+  - **validator**: <function validateDescription at 0x102e94dc0>
 * `values_A`=\<list\>: Names of values to query with database A.
   - **default value**: []
   - **current value**: [], from {default}

docs/user/components/spatialdb/GravityField.md

@@ -15,8 +15,8 @@ Implements `SpatialDB`.
   - **current value**: 9.80665*m*s**-2, from {default}
 * `description`=\<str\>: Description for database.
   - **default value**: ''
-  - **current value**: 'Gravity field', from {file='/Users/baagaard/software/unix/py39-venv/pylith-debug/lib/python3.9/site-packages/pythia/pyre/inventory/ConfigurableClass.py', line=26, function='__set__'}
-  - **validator**: <function validateDescription at 0x112cb1dc0>
+  - **current value**: 'Gravity field', from {file='/Users/baagaard/software/unix/py310-venv/pylith-debug/lib/python3.10/site-packages/pythia/pyre/inventory/ConfigurableClass.py', line=26, function='__set__'}
+  - **validator**: <function validateDescription at 0x102e94dc0>
 * `gravity_dir`=\<list\>: Direction of gravitational body force. (used only with a Cartesian coordinate system.
   - **default value**: [0.0, 0.0, -1.0]
   - **current value**: [0.0, 0.0, -1.0], from {default}

docs/user/components/spatialdb/SCECCVMH.md

@@ -19,8 +19,8 @@ These models are obsolete and no longer available from SCEC.
   - **current value**: '.', from {default}
 * `description`=\<str\>: Description for database.
   - **default value**: ''
-  - **current value**: 'SCEC CVM-H v5.3', from {file='/Users/baagaard/software/unix/py39-venv/pylith-debug/lib/python3.9/site-packages/pythia/pyre/inventory/ConfigurableClass.py', line=26, function='__set__'}
-  - **validator**: <function validateDescription at 0x112cb1dc0>
+  - **current value**: 'SCEC CVM-H v5.3', from {file='/Users/baagaard/software/unix/py310-venv/pylith-debug/lib/python3.10/site-packages/pythia/pyre/inventory/ConfigurableClass.py', line=26, function='__set__'}
+  - **validator**: <function validateDescription at 0x102e94dc0>
 * `min_vs`=\<dimensional\>: Minimum shear wave speed.
   - **default value**: 500*m*s**-1
   - **current value**: 500*m*s**-1, from {default}

docs/user/components/spatialdb/SimpleDB.md

@@ -20,7 +20,7 @@ Implements `SpatialDB`.
 * `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x112cb1dc0>
+  - **validator**: <function validateDescription at 0x102e94dc0>
 * `query_type`=\<str\>: Type of query to perform.
   - **default value**: 'nearest'
   - **current value**: 'nearest', from {default}

docs/user/components/spatialdb/SimpleGridAscii.md

@@ -11,7 +11,7 @@ ASCII writer for a simple grid spatial database.
 * `filename`=\<str\>: Name of database file.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateFilename at 0x11d1be0d0>
+  - **validator**: <function validateFilename at 0x102e968c0>
 
 ## Example