Skip to content

Commit b575bb3

Browse files
baagaard-usgsbaagaard-usgs
committed
DOCS: Add documentation for CSGeoLocal.
1 parent 70fc6da commit b575bb3

21 files changed

+294
-23
lines changed

‎docs/tikz-styles/figcolors.tex‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
\definecolor{yellow}{rgb}{1.0, 1.0, 0.45} % 255/255/115
2+
\definecolor{dkyellow}{rgb}{0.9, 0.9, 0.0} % % 230/230/0
3+
4+
\definecolor{ltorange}{rgb}{1.0, 0.74, 0.41} % 255/188/105
5+
\definecolor{orange}{rgb}{0.96, 0.50, 0.0} % 246/127/0
6+
7+
\definecolor{ltred}{rgb}{1.0, 0.25, 0.25} % 255/64/64
8+
\definecolor{red}{rgb}{0.79, 0.00, 0.01} % 201/0/3
9+
10+
\definecolor{ltpurple}{rgb}{0.81, 0.57, 1.00} % 206/145/255
11+
\definecolor{purple}{rgb}{0.38, 0.00, 0.68} % 97/1/175
12+
13+
\definecolor{ltblue}{rgb}{0.2, 0.73, 1.0} % 51/187/255
14+
\definecolor{blue}{rgb}{0.12, 0.43, 0.59} % 30/110/150
15+
16+
\definecolor{ltltgreen}{rgb}{0.7, 1.00, 0.7} % 96/204/14
17+
\definecolor{ltgreen}{rgb}{0.37, 0.80, 0.05} % 96/204/14
18+
\definecolor{green}{rgb}{0.23, 0.49, 0.03} % 59/125/8
19+
20+
\definecolor{dkslate}{rgb}{0.18, 0.21, 0.28} % 47/53/72
21+
\definecolor{mdslate}{rgb}{0.45, 0.50, 0.68} % 114/127/173
22+
\definecolor{ltslate}{rgb}{0.85, 0.88, 0.95} % 216/225/229

‎docs/user/components/geocoords/CSGeoLocal.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# CSGeoLocal
2+
3+
% WARNING: Do not edit; this is a generated file!
4+
:Full name: `spatialdata.geocoords.CSGeoLocal`
5+
:Journal name: `csgeoLocal`
6+
7+
Python manager for local, rotated geographic coordinate systems.
8+
9+
Implements `CSGeo`.
10+
11+
## Pyre Properties
12+
13+
* `crs_string`=\<str\>: String specifying coordinate system (PROJ parameters, EPSG, or WKT). Default is WGS84.
14+
- **default value**: 'EPSG:4326'
15+
- **current value**: 'EPSG:4326', from {default}
16+
* `origin_x`=\<float\>: X coordinate of local origin.
17+
- **default value**: 0.0
18+
- **current value**: 0.0, from {default}
19+
* `origin_y`=\<float\>: Y coordinate of local origin.
20+
- **default value**: 0.0
21+
- **current value**: 0.0, from {default}
22+
* `space_dim`=\<int\>: Number of dimensions for coordinate system.
23+
- **default value**: 3
24+
- **current value**: 3, from {default}
25+
* `y_azimuth`=\<float\>: Azimuth (degrees) of local y axis.
26+
- **default value**: 0.0
27+
- **current value**: 0.0, from {default}
28+
29+
## Example
30+
31+
Example of setting `CSGeoLocal` Pyre properties and facilities in a parameter file.
32+
33+
:::{code-block} cfg
34+
[coordsys]
35+
# Local, rotated UTM Zone 10 coordinate system
36+
crs_string = EPSG:29610
37+
space_dim = 2
38+
origin_x = 300000.0
39+
origin_y = 4000000.0
40+
y_azimuth = -25.0
41+
:::
42+

‎docs/user/components/geocoords/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ maxdepth: 1
88
---
99
CSCart.md
1010
CSGeo.md
11+
CSGeoLocal.md
1112
CoordSys.md
1213
:::

‎docs/user/components/spatialdb/AnalyticDB.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
:Full name: `spatialdata.spatialdb.AnalyticDB`
55
:Journal name: `AnalyticDB`
66

7-
Spatial database with uniform values.
7+
Spatial database composed of analytic functions.
88

99
Implements `SpatialDB`.
1010

@@ -19,7 +19,7 @@ Implements `SpatialDB`.
1919
* `description`=\<str\>: Description for database.
2020
- **default value**: ''
2121
- **current value**: '', from {default}
22-
- **validator**: <function validateDescription at 0x1061fcc10>
22+
- **validator**: <function validateDescription at 0x102e94dc0>
2323
* `expressions`=\<list\>: Analytical expressions for values in spatial database.
2424
- **default value**: []
2525
- **current value**: [], from {default}
@@ -40,5 +40,7 @@ description = Uniform material properties
4040
values = [density, vp, vs]
4141
units = [kg/m**3, km/s, m/s]
4242
expressions = [2.0*x-y, 2.0x*x/(y*y), -2.0*z]
43+
cs = spatialdata.geocoords.CSCart
44+
cs.space_dim = 3
4345
:::
4446

‎docs/user/components/spatialdb/CompositeDB.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Implements `SpatialDB`.
2323
* `description`=\<str\>: Description for database.
2424
- **default value**: ''
2525
- **current value**: '', from {default}
26-
- **validator**: <function validateDescription at 0x112cb1dc0>
26+
- **validator**: <function validateDescription at 0x102e94dc0>
2727
* `values_A`=\<list\>: Names of values to query with database A.
2828
- **default value**: []
2929
- **current value**: [], from {default}

‎docs/user/components/spatialdb/GravityField.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Implements `SpatialDB`.
1515
- **current value**: 9.80665*m*s**-2, from {default}
1616
* `description`=\<str\>: Description for database.
1717
- **default value**: ''
18-
- **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__'}
19-
- **validator**: <function validateDescription at 0x112cb1dc0>
18+
- **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__'}
19+
- **validator**: <function validateDescription at 0x102e94dc0>
2020
* `gravity_dir`=\<list\>: Direction of gravitational body force. (used only with a Cartesian coordinate system.
2121
- **default value**: [0.0, 0.0, -1.0]
2222
- **current value**: [0.0, 0.0, -1.0], from {default}

‎docs/user/components/spatialdb/SCECCVMH.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ These models are obsolete and no longer available from SCEC.
1919
- **current value**: '.', from {default}
2020
* `description`=\<str\>: Description for database.
2121
- **default value**: ''
22-
- **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__'}
23-
- **validator**: <function validateDescription at 0x112cb1dc0>
22+
- **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__'}
23+
- **validator**: <function validateDescription at 0x102e94dc0>
2424
* `min_vs`=\<dimensional\>: Minimum shear wave speed.
2525
- **default value**: 500*m*s**-1
2626
- **current value**: 500*m*s**-1, from {default}

‎docs/user/components/spatialdb/SimpleDB.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Implements `SpatialDB`.
2020
* `description`=\<str\>: Description for database.
2121
- **default value**: ''
2222
- **current value**: '', from {default}
23-
- **validator**: <function validateDescription at 0x112cb1dc0>
23+
- **validator**: <function validateDescription at 0x102e94dc0>
2424
* `query_type`=\<str\>: Type of query to perform.
2525
- **default value**: 'nearest'
2626
- **current value**: 'nearest', from {default}

‎docs/user/components/spatialdb/SimpleGridAscii.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ASCII writer for a simple grid spatial database.
1111
* `filename`=\<str\>: Name of database file.
1212
- **default value**: ''
1313
- **current value**: '', from {default}
14-
- **validator**: <function validateFilename at 0x11d1be0d0>
14+
- **validator**: <function validateFilename at 0x102e968c0>
1515

1616
## Example
1717

‎docs/user/components/spatialdb/SimpleGridDB.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ Implements `SpatialDB`.
1414
* `description`=\<str\>: Description for database.
1515
- **default value**: ''
1616
- **current value**: '', from {default}
17-
- **validator**: <function validateDescription at 0x112cb1dc0>
17+
- **validator**: <function validateDescription at 0x102e94dc0>
1818
* `filename`=\<str\>: Name for data file.
1919
- **default value**: ''
2020
- **current value**: '', from {default}
21-
- **validator**: <function validateFilename at 0x11d1d1ca0>
21+
- **validator**: <function validateFilename at 0x103178ca0>
2222
* `query_type`=\<str\>: Type of query to perform.
2323
- **default value**: 'nearest'
2424
- **current value**: 'nearest', from {default}

0 commit comments

Comments
 (0)