Skip to content

Commit a538900

Browse files
authored
Updated parameter descriptions to reduce the amount of text (#664)
1 parent 3a29859 commit a538900

File tree

3 files changed

+6
-24
lines changed

3 files changed

+6
-24
lines changed

pyincore/analyses/housingvaluationrecovery/housingvaluationrecovery.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,7 @@ def get_spec(self):
5757
"id": "base_year",
5858
"required": False,
5959
"description": "Base year is used to calculate the improvement age. It should be set to the "
60-
"tax assessment year that represents pre-disaster building values. For example, "
61-
"in GCAD data, this corresponds to the improvement valuation before the impacts "
62-
"of Hurricane Ike. The default value is 2008.",
60+
"tax assessment year that represents pre-disaster building values. The default value is 2008.",
6361
"type": int,
6462
},
6563
{

pyincore/analyses/indp/indp.py

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,17 +1151,7 @@ def get_spec(self):
11511151
"required": True,
11521152
"description": "List of resource caps or the number of available resources at each step of "
11531153
"the analysis. Each item in the list is a dictionary specifying the resource type and the "
1154-
"corresponding quantity available. "
1155-
"For example: "
1156-
"* If `network_type`=*from_csv*, you have two options:* if, for example, "
1157-
'`R_c`= [{"budget": 3}, {"budget": 6}], then the analysis is done for the cases '
1158-
'when there are 3 and 6 resources available of type "budget" '
1159-
'(total resource assignment).* if, for example, `R_c`= [{"budget": {1:1, 2:1}}, '
1160-
'{"budget": {1:1, 2:2}}, {"budget": {1:3, 2:3}}] and given there are 2 layers,'
1161-
" then the analysis is done for the case where each layer gets 1 resource of "
1162-
'type "budget", AND the case where layer 1 gets 1 and layer 2 gets 2 resources of '
1163-
'type "budget", AND the case where each layer gets 3 resources of type '
1164-
'"budget" (Prescribed resource for each layer).',
1154+
"corresponding quantity available. ",
11651155
"type": list,
11661156
},
11671157
{
@@ -1173,11 +1163,9 @@ def get_spec(self):
11731163
{
11741164
"id": "method",
11751165
"required": True,
1176-
"description": "Based name of method to use. "
1177-
"There are two choices of method: 1. `INDP`: runs Interdependent Network. "
1178-
"Restoration Problem (INDP). 2. `TDINDP`: runs time-dependent INDP (td-INDP). In "
1179-
'both cases, if "TIME_RESOURCE" is True, then the repair time for each element '
1180-
"is considered in devising the restoration plans.",
1166+
"description": "There are two choices of method: 1. INDP: runs Interdependent Network Restoration "
1167+
"Problem (INDP). 2. TDINDP: runs time-dependent INDP (td-INDP). In both cases, if TIME_RESOURCE is "
1168+
"True, then the repair time for each element is considered.",
11811169
"type": str,
11821170
},
11831171
{

pyincore/analyses/montecarlolimitstateprobability/montecarlolimitstateprobability.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,7 @@ def get_spec(self):
4444
{
4545
"id": "result_name",
4646
"required": True,
47-
"description": "Base name of the result datasets. This analysis will create two outputs: failure "
48-
"probability and failure state with the basename in the filename. "
49-
'For example: "result_name = joplin_mcs_building" will result in '
50-
'"joplin_mcs_building_failure_state.csv" and '
51-
'"joplin_mcs_building_failure_probability.csv"',
47+
"description": "Base name of the result datasets.",
5248
"type": str,
5349
},
5450
{

0 commit comments

Comments
 (0)