Merge pull request #64 from geodynamics/baagaard/docs-journal-name

baagaard-usgs · web-flow · commit 2f899ec8602f · 2022-05-13T08:26:51.000-06:00
DOCS: Add journal name to Pyre component documentation.
diff --git a/docs/user/components/geocoords/CSCart.md b/docs/user/components/geocoords/CSCart.md
@@ -1,7 +1,8 @@
 # CSCart
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.geocoords.CSCart`
+:Full name: `spatialdata.geocoords.CSCart`
+:Journal name: `cscart`
 
 Python manager for Cartesian coordinate systems.
 
diff --git a/docs/user/components/geocoords/CSGeo.md b/docs/user/components/geocoords/CSGeo.md
@@ -1,7 +1,8 @@
 # CSGeo
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.geocoords.CSGeo`
+:Full name: `spatialdata.geocoords.CSGeo`
+:Journal name: `csgeo`
 
 Python manager for geographic coordinate systems.
 
diff --git a/docs/user/components/geocoords/CoordSys.md b/docs/user/components/geocoords/CoordSys.md
@@ -1,7 +1,8 @@
 # CoordSys
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.geocoords.CoordSys`
+:Full name: `spatialdata.geocoords.CoordSys`
+:Journal name: `coordsys`
 
 Python abstract base class for coordinate systems.
 
diff --git a/docs/user/components/spatialdb/CompositeDB.md b/docs/user/components/spatialdb/CompositeDB.md
@@ -1,7 +1,8 @@
 # CompositeDB
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.CompositeDB`
+:Full name: `spatialdata.spatialdb.CompositeDB`
+:Journal name: `compositedb`
 
 Virtual spatial database implemented as a combination of two spatial databases.
 This spatial database is useful when you need to provide additional values beyond those present in an existing spatial database or some values have a different layout than others.
@@ -19,10 +20,10 @@ Implements `SpatialDB`.
 
 ## Pyre Properties
 
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **validator**: <function validateDescription at 0x112cb1dc0>
 * `values_A`=\<list\>: Names of values to query with database A.
   - **default value**: []
   - **current value**: [], from {default}
@@ -40,12 +41,12 @@ values_A = [density]
 values_B = [vp, vs]
 
 db_A = spatialdata.spatialdb.UniformDB
-db_A.label = Density spatial database.
+db_A.description = Density spatial database.
 db_A.values = [density]
 db_A.data = [3000*kg/m**3]
 
 db_B = spatialdata.spatialdb.SimpleDB
-db_B.label = Wave speed spatial database.
+db_B.description = Wave speed spatial database.
 db_B.iohandler.filename = vpvs.spatialdb
 :::
 
diff --git a/docs/user/components/spatialdb/GravityField.md b/docs/user/components/spatialdb/GravityField.md
@@ -1,27 +1,25 @@
 # GravityField
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.GravityField`
+:Full name: `spatialdata.spatialdb.GravityField`
+:Journal name: `gravityfield`
 
 Spatial database with gravity field information.
 
-Implements `SpatialDB`.
+Implements `SpatialDB`. 
 
 ## Pyre Properties
 
 * `acceleration`=\<dimensional\>: Gravitational acceleration.
   - **default value**: 9.80665*m*s**-2
   - **current value**: 9.80665*m*s**-2, from {default}
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
-  - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **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>
 * `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}
-* `label`=\<str\>: Descriptive label for gravity field.
-  - **default value**: 'Gravity field'
-  - **current value**: 'Gravity field', from {default}
 
 ## Example
 
@@ -30,7 +28,6 @@ Example of setting `GravityField` Pyre properties and facilities in a parameter
 :::{code-block} cfg
 # Specify a gravity field in 2D with gravity in the -y direction.
 [gravity_field]
-label = Gravity field
 gravity_dir = [0, -1]
 acceleration = 9.80665*meter/second**2
 :::
diff --git a/docs/user/components/spatialdb/SCECCVMH.md b/docs/user/components/spatialdb/SCECCVMH.md
@@ -1,7 +1,8 @@
 # SCECCVMH
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.SCECCVMH`
+:Full name: `spatialdata.spatialdb.SCECCVMH`
+:Journal name: `sceccvmh`
 
 Spatial database for the SCEC CVM-H seismic velocity model versions 5.2 and 5.3.
 
@@ -16,13 +17,10 @@ These models are obsolete and no longer available from SCEC.
 * `data_dir`=\<str\>: Directory containing SCEC CVM-H data files.
   - **default value**: '.'
   - **current value**: '.', from {default}
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
-  - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
-* `label`=\<str\>: Descriptive label for seismic velocity model.
-  - **default value**: 'SCEC CVM-H'
-  - **current value**: 'SCEC CVM-H', from {default}
+  - **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>
 * `min_vs`=\<dimensional\>: Minimum shear wave speed.
   - **default value**: 500*m*s**-1
   - **current value**: 500*m*s**-1, from {default}
@@ -38,7 +36,6 @@ These models are obsolete and no longer available from SCEC.
 Example of setting `SCECCVMH` Pyre properties and facilities in a parameter file.
 
 :::{code-block} cfg
-label = SCEC CVM-H v5.3
 data_dir = data/scec-cvmh
 min_vs = 500.0*m/s
 squash = False
diff --git a/docs/user/components/spatialdb/SimpleDB.md b/docs/user/components/spatialdb/SimpleDB.md
@@ -1,7 +1,8 @@
 # SimpleDB
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.SimpleDB`
+:Full name: `spatialdata.spatialdb.SimpleDB`
+:Journal name: `simpledb`
 
 Simple spatial database for points with arbitrary layout.
 Use SimpleGridDB for points on a logically rectangular grid aligned with the coordinate axes.
@@ -16,10 +17,10 @@ Implements `SpatialDB`.
 
 ## Pyre Properties
 
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **validator**: <function validateDescription at 0x112cb1dc0>
 * `query_type`=\<str\>: Type of query to perform.
   - **default value**: 'nearest'
   - **current value**: 'nearest', from {default}
@@ -31,7 +32,7 @@ Example of setting `SimpleDB` Pyre properties and facilities in a parameter file
 
 :::{code-block} cfg
 [db]
-label = Material properties
+description = Material properties
 query_type = linear
 iohandler.filename = mat_elastic.spatialdb
 :::
diff --git a/docs/user/components/spatialdb/SimpleGridAscii.md b/docs/user/components/spatialdb/SimpleGridAscii.md
@@ -1,7 +1,8 @@
 # SimpleGridAscii
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.SimpleGridAscii`
+:Full name: `spatialdata.spatialdb.SimpleGridAscii`
+:Journal name: `simplegridascii`
 
 ASCII writer for a simple grid spatial database.
 
@@ -10,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 0x11e4ec310>
+  - **validator**: <function validateFilename at 0x11d1be0d0>
 
 ## Example
 
diff --git a/docs/user/components/spatialdb/SimpleGridDB.md b/docs/user/components/spatialdb/SimpleGridDB.md
@@ -1,7 +1,8 @@
 # SimpleGridDB
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.SimpleGridDB`
+:Full name: `spatialdata.spatialdb.SimpleGridDB`
+:Journal name: `simplegriddb`
 
 Simple spatial database on a logically rectangular grid aligned with the coordinate axes.
 Points along the coordinate axes do not have to be uniformly spaced.
@@ -10,14 +11,14 @@ Implements `SpatialDB`.
 
 ## Pyre Properties
 
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **validator**: <function validateDescription at 0x112cb1dc0>
 * `filename`=\<str\>: Name for data file.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateFilename at 0x11e502c10>
+  - **validator**: <function validateFilename at 0x11d1d1ca0>
 * `query_type`=\<str\>: Type of query to perform.
   - **default value**: 'nearest'
   - **current value**: 'nearest', from {default}
@@ -29,7 +30,7 @@ Example of setting `SimpleGridDB` Pyre properties and facilities in a parameter
 
 :::{code-block} cfg
 [db]
-label = Material properties
+description = Material properties
 filename = mat_elastic.spatialdb
 query_type = linear
 :::
diff --git a/docs/user/components/spatialdb/SimpleIOAscii.md b/docs/user/components/spatialdb/SimpleIOAscii.md
@@ -1,7 +1,8 @@
 # SimpleIOAscii
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.SimpleIOAscii`
+:Full name: `spatialdata.spatialdb.SimpleIOAscii`
+:Journal name: `simpleioascii`
 
 ASCII writer for a simple spatial database (SimpleDB).
 
@@ -12,7 +13,7 @@ Implements `SimpleIO`.
 * `filename`=\<str\>: Name of database file.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateFilename at 0x11e502040>
+  - **validator**: <function validateFilename at 0x11d1beca0>
 
 ## Example
 
diff --git a/docs/user/components/spatialdb/SpatialDBObj.md b/docs/user/components/spatialdb/SpatialDBObj.md
@@ -1,14 +1,15 @@
 # SpatialDBObj
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.SpatialDBObj`
+:Full name: `spatialdata.spatialdb.SpatialDBObj`
+:Journal name: `spatialdb`
 
 Python abstract base class for spatial database.
 
 ## Pyre Properties
 
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **validator**: <function validateDescription at 0x112cb1dc0>
 
diff --git a/docs/user/components/spatialdb/TimeHistory.md b/docs/user/components/spatialdb/TimeHistory.md
@@ -1,7 +1,8 @@
 # TimeHistory
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.TimeHistory`
+:Full name: `spatialdata.spatialdb.TimeHistory`
+:Journal name: `timehistory`
 
 Time history object for specifying temporal variation in a field.
 
@@ -13,7 +14,7 @@ Time history object for specifying temporal variation in a field.
 * `filename`=\<str\>: Name of file for time history.
   - **default value**: 'timehistory.timedb'
   - **current value**: 'timehistory.timedb', from {default}
-  - **validator**: <function validateFilename at 0x11c2c1c10>
+  - **validator**: <function validateFilename at 0x11d0dbdc0>
 
 ## Example
 
diff --git a/docs/user/components/spatialdb/UniformDB.md b/docs/user/components/spatialdb/UniformDB.md
@@ -1,7 +1,8 @@
 # UniformDB
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.UniformDB`
+:Full name: `spatialdata.spatialdb.UniformDB`
+:Journal name: `uniformdb`
 
 Spatial database with uniform values.
 
@@ -12,10 +13,10 @@ Implements `SpatialDB`.
 * `data`=\<list\>: Values in spatial database.
   - **default value**: []
   - **current value**: [], from {default}
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **validator**: <function validateDescription at 0x112cb1dc0>
 * `values`=\<list\>: Names of values in spatial database.
   - **default value**: []
   - **current value**: [], from {default}
@@ -26,7 +27,7 @@ Example of setting `UniformDB` Pyre properties and facilities in a parameter fil
 
 :::{code-block} cfg
 [db]
-label = Uniform material properties
+description = Uniform material properties
 values = [density, vp, vs]
 data = [2000*kg/m**3, 2.0*km/s, 1000*m/s]
 :::
diff --git a/docs/user/components/spatialdb/UserFunctionDB.md b/docs/user/components/spatialdb/UserFunctionDB.md
@@ -1,7 +1,8 @@
 # UserFunctionDB
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.UserFunctionDB`
+:Full name: `spatialdata.spatialdb.UserFunctionDB`
+:Journal name: `userfunctiondb`
 
 Analytical function spatial database.
 The analytical function must be provided in C++.
@@ -17,18 +18,18 @@ Implements `SpatialDB`.
 
 ## Pyre Properties
 
-* `description`=\<str\>: Descriptive description for database.
+* `description`=\<str\>: Description for database.
   - **default value**: ''
   - **current value**: '', from {default}
-  - **validator**: <function validateDescription at 0x11c2979d0>
+  - **validator**: <function validateDescription at 0x112cb1dc0>
 
 ## Example
 
 Example of setting `UserFunctionDB` Pyre properties and facilities in a parameter file.
 
 :::{code-block} cfg
 [db]
-label = Linear function
+description = Linear function
 cs = spatialdata.geocoords.CSCart
 cs.space_dim = 2
 :::
diff --git a/docs/user/components/spatialdb/generator/GenSimpleDBApp.md b/docs/user/components/spatialdb/generator/GenSimpleDBApp.md
@@ -1,7 +1,8 @@
 # GenSimpleDBApp
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.generator.GenSimpleDBApp`
+:Full name: `spatialdata.spatialdb.generator.GenSimpleDBApp`
+:Journal name: `gensimpledb`
 
 Application to generate simple spatial database.
 
@@ -22,7 +23,7 @@ Application to generate simple spatial database.
 * `filename`=\<str\>: Filename for generated ASCII SimpleDB.
   - **default value**: ''
   - **current value**: '/Users/baagaard/src/cig/pythia/bin/pyre_doc_components.py', 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 validateFilename at 0x11afbb1f0>
+  - **validator**: <function validateFilename at 0x11d1fa1f0>
 * `typos`=\<str\>: specifies the handling of typos in the names of properties and facilities
   - **default value**: 'strict'
   - **current value**: 'strict', from {default}
diff --git a/docs/user/components/spatialdb/generator/Geometry.md b/docs/user/components/spatialdb/generator/Geometry.md
@@ -1,7 +1,8 @@
 # Geometry
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.generator.Geometry`
+:Full name: `spatialdata.spatialdb.generator.Geometry`
+:Journal name: `geometry`
 
 Geometry used in generating database.
 
diff --git a/docs/user/components/spatialdb/generator/Shaper.md b/docs/user/components/spatialdb/generator/Shaper.md
@@ -1,7 +1,8 @@
 # Shaper
 
 % WARNING: Do not edit; this is a generated file!
-Full name: `spatialdata.spatialdb.generator.Shaper`
+:Full name: `spatialdata.spatialdb.generator.Shaper`
+:Journal name: `shaper`
 
 Object for shaping spatial distribution of data while generating database.
 
diff --git a/docs/user/components/spatialdb/generator/Value.md b/docs/user/components/spatialdb/generator/Value.md
diff --git a/docs/user/components/units/NondimElasticDynamic.md b/docs/user/components/units/NondimElasticDynamic.md
diff --git a/docs/user/components/units/NondimElasticQuasistatic.md b/docs/user/components/units/NondimElasticQuasistatic.md
diff --git a/docs/user/components/units/Nondimensional.md b/docs/user/components/units/Nondimensional.md
diff --git a/docs/user/components/update.sh b/docs/user/components/update.sh
diff --git a/docs/user/components/utils/PointsStream.md b/docs/user/components/utils/PointsStream.md
diff --git a/docs/user/components/utils/UnitTestApp.md b/docs/user/components/utils/UnitTestApp.md
