Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions deploy/runtime/startup.lk

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions deploy/runtime/ui/Electric Building Load Calculator.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@
},
"X": {
"Type": 3.0,
"Integer": 9.0
"Integer": 6.0
},
"Y": {
"Type": 3.0,
"Integer": 510.0
"Integer": 516.0
},
"Width": {
"Type": 3.0,
Expand Down Expand Up @@ -90,7 +90,7 @@
},
"Y": {
"Type": 3.0,
"Integer": 522.0
"Integer": 531.0
},
"Width": {
"Type": 3.0,
Expand Down
2 changes: 1 addition & 1 deletion deploy/runtime/ui/MSPT IPH Dispatch Control.json
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@
},
"ColLabels": {
"Type": 5.0,
"String": "Turbine output fraction"
"String": "Heat sink output fraction"
},
"NumRowsLabel": {
"Type": 5.0,
Expand Down
34 changes: 23 additions & 11 deletions deploy/runtime/ui/Solar Resource Download.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@
},
"Caption": {
"Type": 5.0,
"String": "Visit the SAM website Weather Page for links to other data sources."
"String": "Visit the SAM website Weather Page for links to other data sources"
},
"URL": {
"Type": 5.0,
"String": "https://sam.nrel.gov/weather-data"
"String": "https://sam.nlr.gov/weather-data"
},
"TabOrder": {
"Type": 3.0,
Expand Down Expand Up @@ -110,7 +110,7 @@
},
"Caption": {
"Type": 5.0,
"String": "Show download log"
"String": "Show Download Log"
},
"TabOrder": {
"Type": 3.0,
Expand Down Expand Up @@ -643,7 +643,7 @@
"Callbacks": [
"on_load{'Solar Resource Download'} = define() {\r",
"\t//msgbox('Debug\\non_load Solar Resource Download');",
"\tenable('in_location_list', value('in_location_options') == 1 );\r",
"\tenable_options();\r",
"\tshow_hide_advanced();\r",
"};",
"\r",
Expand All @@ -668,31 +668,37 @@
"};\r",
"\r",
"on_change{ 'in_nsrdb_options' } = define() {\r",
"\tenable('in_location_list', value('in_location_options') == 1 && !value('is_advanced'));\r",
"\tenable('in_location', value('in_location_options') == 0 && !value('is_advanced'));\r",
"\tenable('in_location_options', !value('is_advanced') );\r",
"\t// 30-minute data not available for tmy\r",
"\tshow('in_time_step', value('in_nsrdb_options') != 0 && !value('is_advanced')); \r",
"\trefresh();\r",
"\tenable_options();\r",
"};\r",
"\r",
"on_change{ 'is_advanced' } = define() {\r",
"\tshow_hide_advanced();\r",
"};\r",
"\r",
"function enable_options() {\r",
"\tenable('in_location_list', value('in_location_options') == 1 && !value('is_advanced'));\r",
"\tenable('in_location', value('in_location_options') == 0 && !value('is_advanced'));\r",
"\tenable('in_location_options', !value('is_advanced') );\r",
"\t// 30-minute data not available for tmy\r",
"\tenable('in_time_step', value('in_nsrdb_options') != 0 && !value('is_advanced')); \r",
"}\r",
"\r",
"function show_hide_advanced() {\r",
"\tif ( value('is_advanced') ) {\r",
"\t\tproperty( 'download_weather_caption' , 'Caption' , 'Click the Download button to choose files from a complete list of files available from the NSRDB, including TMY, TGY, TDY for different years and subhourly data.');\r",
"\t\tproperty( 'download_weather_caption' , 'TextColour', 'black' );\r",
"\t\tproperty( 'btn_download', 'Caption', 'Advanced NSRDB Options...');\r",
"\t}\r",
"\telse {\r",
"\t\tproperty( 'download_weather_caption' , 'Caption' , 'The NSRDB is a database of weather files that you can download and add to your to your solar resource library: Download a default typical-year (TMY) file for most long-term cash flow analyses, or choose files for single-year or P50/P90 analyses. See Help for details.' );\r",
"\t\tproperty( 'download_weather_caption' , 'TextColour', 'black' );\r",
"\t\tproperty( 'btn_download', 'Caption', 'Download');\r",
"\r",
"\t}\r",
"\tshow('options_divider', !value('is_advanced') );\r",
"\tshow('in_location_options', !value('is_advanced') );\r",
"\tshow('in_nsrdb_options', !value('is_advanced') );\r",
"\tshow('in_time_step', value('in_nsrdb_options') != 0 && !value('is_advanced')); \r",
"\tshow('in_time_step', !value('is_advanced')); \r",
"\tshow('in_location_list', !value('is_advanced') );\r",
"\tshow('in_location', !value('is_advanced') );\r",
"\trefresh();\r",
Expand Down Expand Up @@ -914,6 +920,12 @@
"}\r",
"\r",
"function nsrdb_get() {\r",
"\r",
"\tif (value('in_location') == '' ) {\r",
"\t\tmsgbox('Weather File Download Error!\\nPlease type a location name, street address, or coordinates before clicking Download.');\r",
"\t\texit;\r",
"\t}\r",
"\t\r",
"\tenum { ADDRESS, COORDINATES };\r",
"\tenum { TMY, SINGLE_YEAR, ALL_YEARS };\r",
"\tenum { ONE_LOCATION, MULTIPLE_LOCATIONS };\r",
Expand Down
21 changes: 9 additions & 12 deletions deploy/runtime/ui/Solar Resource Information.json
Original file line number Diff line number Diff line change
Expand Up @@ -1511,7 +1511,7 @@
},
"Caption": {
"Type": 5.0,
"String": ""
"String": "Caption set by update_info()"
},
"TextColour": {
"Type": 4.0,
Expand Down Expand Up @@ -2026,7 +2026,6 @@
"on_load{'Solar Resource Information'} = define() {",
"\t//msgbox('Debug\\non_load Solar Resource Information');",
"\tupdate_info( 'on_load Solar Resource Information');\r",
"\tdisplay_tech_message();\r",
"};",
"",
"on_change{'btn_view_data'} = define() {",
Expand Down Expand Up @@ -2110,10 +2109,10 @@
"\t\t\tvalue( 'annual_snow', ssc_var(obj, 'annual_snow') );\r",
"\t\t\tvalue( 'annual_albedo', ssc_var(obj, 'annual_albedo') );\r",
"\t\t\tvalue( 'step', ssc_var(obj, 'step') );\r",
"\t\t\t\r",
"\r",
"\t\t\trhum = ssc_var(obj, 'rhum');\r",
"\t\t\trhum_ok = true;\r",
"\t\t\tif ( isnan( rhum[0] ) ) { rhum_ok = false; }\r",
"\t\t\t\r",
"\t\t\t// used for timestep calculation in editscene3d\r",
"\t\t\tvalue( 'wf_nrecords', ssc_var(obj, 'nrecords') );\r",
"\t\t}\r",
Expand All @@ -2126,10 +2125,8 @@
"\t\t}\r",
"\t\tssc_free( obj );\r",
"\t}\r",
"}\r",
"",
"function display_tech_message() \r",
"{\r",
"\r",
"\t// display tech-specific messages\r",
"\tstr = '';\r",
"\tstr_and = '';\r",
"\ttech = technology();\r",
Expand All @@ -2143,6 +2140,9 @@
"\t}\r",
"\tif ( tech == 'Biopower' )\r",
"\t{ \r",
"\r",
"\t\tif ( isnan( rhum[0] ) ) { rhum_ok = false; }\r",
"\t\r",
"\t\tif ( isnan( value('annual_global') ) || !rhum_ok )\r",
"\t\t{\r",
"\t\t\tstr = 'The Biopower model requires ';\r",
Expand All @@ -2159,11 +2159,8 @@
"\t}\r",
"\tproperty( 'caption_techs' , 'Caption', str );\t\t\r",
"\tproperty( 'caption_techs' , 'TextColour', 'red' );\r",
"}\r",
"\r",
"\r",
"\r",
"\r",
"}\r",
"\r",
""
]
Expand Down
12 changes: 6 additions & 6 deletions deploy/runtime/ui/Solar Resource Library.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
},
"TabOrder": {
"Type": 3.0,
"Integer": 2.0
"Integer": 1.0
}
}
},
Expand Down Expand Up @@ -106,11 +106,11 @@
},
"Caption": {
"Type": 5.0,
"String": "Browse"
"String": "Browse..."
},
"TabOrder": {
"Type": 3.0,
"Integer": -1.0
"Integer": 5.0
}
}
},
Expand Down Expand Up @@ -147,7 +147,7 @@
},
"TabOrder": {
"Type": 3.0,
"Integer": 3.0
"Integer": 2.0
}
}
},
Expand Down Expand Up @@ -525,7 +525,7 @@
},
"Caption": {
"Type": 5.0,
"String": "Choose a weather file from the library or from a folder."
"String": "Choose a weather file from the library, or disable the library and choose a file directly."
},
"TextColour": {
"Type": 4.0,
Expand Down Expand Up @@ -691,7 +691,7 @@
},
"TabOrder": {
"Type": 3.0,
"Integer": -1.0
"Integer": 3.0
}
}
},
Expand Down
39 changes: 34 additions & 5 deletions doc/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ If possible, avoid using headings in snippet files to avoid inconsistencies betw

## Headings

Limit section headings to three levels, plus Level 4 for procedure titles.
Limit section headings to three levels.

In reStructuredText, headings are identified by underline characters (https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections). The character used to underline the text determines the heading level based on the "succession of headings" in each file. This means that each file can use different characters to represent heading levels.

Expand Down Expand Up @@ -269,9 +269,10 @@ The "~" character now represents Heading 2 because of the order above.

Use `#` to automatically number lists. Use `*` for bulleted lists. Lines in a list can be separated by a blank line or not.

For the title of step-by-step instructions, use **bold** text (`**bold**`) instead of a heading so that the format is consistent across all documents.

```
Heading 4: Step-by-step instructions:
.....................................
**Step-by-step instructions:**

#. This is Step 1 with automatically numbered lines.

Expand Down Expand Up @@ -305,13 +306,13 @@ When creating and editing cross references, you may need to clean and rebuild th

Use `:doc:` for a cross reference to a topic file to create a hyperlink that points to the beginning of the file.

Use the file's title as the hyperlink text:
To use the file's title as the hyperlink text:

```
This is a reference to :doc:`path/to/filename`
```

Use custom hyperlink text:
To use custom hyperlink text:

```
This is a reference to :doc:`hyperlink text <path/to/filename>`
Expand Down Expand Up @@ -459,3 +460,31 @@ You can also use `topic` to create a text box with a custom title. This can be u

An AC degradation rate of 1% for a system with a net annual AC output of 100,000 kWh in Year one results in annual output values of 100,000 kWh in year 1, 99,000 kWh in year 2, 98,010 kWh in year 3, 97,029.9 kWh in year 4, etc.
```

## Literal Blocks

A literal or code block is indented and preceded by `::`.

This results in "This is some code:" (colon is appended to end of line):

```
This is some code::

One line of code.
Another line of code.
And so on.
```

This is just a literal block:

```
::
First line.
Second line.
Third line.
```

## File Names and Paths

Use backticks (\`) to enclose file names or paths like `C:\SAM\2025.4.16`.

Loading
Loading