Skip to content
This repository has been archived by the owner on Sep 27, 2023. It is now read-only.

Add documentation and improve code readability #1330

Draft
wants to merge 35 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
1e9df25
Update version.h
Jun 29, 2023
d9269db
Add support for accessing ISO New England hourly market data (#1307)
dchassin Jul 3, 2023
ac8685f
Add wheel install (#1310)
dchassin Jul 9, 2023
88fe6ce
Add shell subcommand (#1312)
dchassin Jul 10, 2023
c7dcf6f
Update Pole.md
AllisonBrand Jul 12, 2023
ae165db
Increased the level of detail used to descibe the pole attributes
AllisonBrand Jul 12, 2023
473a00c
Create reading-the-code.md
AllisonBrand Jul 12, 2023
2853541
minor grammer edit
AllisonBrand Jul 12, 2023
30ed0f1
Added link for one of the See Also resources
AllisonBrand Jul 12, 2023
69f9e15
Update Pole.md
AllisonBrand Jul 12, 2023
9bd7a55
Update Pole.md
AllisonBrand Jul 12, 2023
8a924ed
Update pole.cpp
AllisonBrand Jul 13, 2023
7c351ad
Added an indication of what's required
AllisonBrand Jul 13, 2023
5124250
Made the verbage more consistent for the definition of pole_stress
AllisonBrand Jul 13, 2023
35170ad
Added more descriptive comments
AllisonBrand Jul 14, 2023
57b0205
Update pole.cpp
AllisonBrand Jul 16, 2023
8dfb1c8
Added a question of mine in the comments
AllisonBrand Jul 16, 2023
c3b0725
Improved documentation and readability
AllisonBrand Jul 21, 2023
d06cc49
Improved readability, edited equation to calc moment on pole face
AllisonBrand Aug 2, 2023
c3928b9
Update version.h
Jun 29, 2023
ec11733
Add support for accessing ISO New England hourly market data (#1307)
dchassin Jul 3, 2023
265940a
Add wheel install (#1310)
dchassin Jul 9, 2023
c4599e4
Add shell subcommand (#1312)
dchassin Jul 10, 2023
e1bbfdd
Update Geodata.md (#1314)
aivanova5 Jul 14, 2023
e0c538a
Fix create_meters.py implementation (#1321)
aivanova5 Jul 28, 2023
cf6901e
Update README.md (#1315)
dchassin Jul 31, 2023
20f2625
Add group tool (#1319)
dchassin Jul 31, 2023
501215c
Added comments, improved readability
AllisonBrand Aug 7, 2023
6bcb23c
Added to documentation and improved variable names
AllisonBrand Aug 13, 2023
71163c1
Update xls-spida2csv-geodata.py
AllisonBrand Aug 13, 2023
0149d40
Documentation for Spida converter
AllisonBrand Aug 22, 2023
3034d9e
Update pole.cpp
AllisonBrand Sep 2, 2023
0263676
Update pole_analysis.py
AllisonBrand Sep 2, 2023
4e9c372
Update Pole.md
AllisonBrand Sep 7, 2023
ff0ef42
Merge branch 'develop' into develop-docs-ice
dchassin Sep 19, 2023
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ The preferred method for running HiPAS GridLAB-D is to download the master image
Once you have installed docker, you may issue the following commands to run GridLAB-D at the command line:

~~~
docker run -it -v $PWD:/model arras-energy/gridlabd:latest gridlabd -W /model [LOADOPTIONS] [FILENAME.EXT] [RUNOPTIONS]
docker run -it -v $PWD:/model lfenergy/arras:latest gridlabd -W /model [LOADOPTIONS] [FILENAME.EXT] [RUNOPTIONS]
~~~

On many systems, an alias can be used to make this a simple command that resembles the command you would normally issue to run a host-based installation:

~~~
alias gridlabd='docker run -it -v $PWD:/tmp arras-energy/gridlabd:latest gridlabd'
alias gridlabd='docker run -it -v $PWD:/tmp lfenergy/arras:latest gridlabd'
~~~

Note that this alias will interfere with any host-based installation. You may use the `gridlabd docker` command to manage the use of docker images concurrently with host-based installations.
Expand Down
18 changes: 6 additions & 12 deletions cloud/websites/docs.gridlabd.us/index.html
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
<!DOCTYPE HTML />
<HTML>
<SCRIPT LANGUAGE="Javascript" SRC="_defaults.js"></SCRIPT>
<SCRIPT LANGUAGE="JavaScript">
document.writeln('<FRAMESET ROWS="' + (top_panel_height+20) + ',*" BORDER=2>');
console.info(window.location.search)
document.writeln('<FRAME SRC="_topbar.html" NORESIZE="noresize"></FRAME>');
document.writeln('<FRAMESET COLS="320,*" BORDER=3>');
document.writeln('<FRAME NAME="contents" SRC="_contents.html' + window.location.search + '"></FRAME>');
document.writeln('<FRAME NAME="page" SRC="_page.html' + window.location.search + '"></FRAME>');
document.writeln('</FRAMESET>');
document.writeln('</FRAMESET>');
</SCRIPT>

<HEAD>
<META HTTP-EQUIV="refresh" CONTENT="0,url=http://docs.gridlabd.us/index.html?owner=arras-energy&project=gridlabd" />
</HEAD>
<BODY>
Redirecting to <A HREF="http://docs.gridlabd.us/index.html?owner=arras-energy&project=gridlabd">http://docs.arras-energy.org/index.html?owner=arras-energy&project=gridlabd</A>...
</BODY>
</HTML>
2 changes: 1 addition & 1 deletion converters/autotest/test_csvgeodata2kml.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
class,pole_length,pole_depth,ground_diameter,fiber_strength,name,tilt_angle,tilt_direction,latitude,longitude,configuration,weather,flags
class,pole_length,pole_depth,ground_diameter,fiber_strength,name,tilt_degree,tilt_direction,latitude,longitude,configuration,weather,flags
pole_configuration,40.0 ft,5.5 ft,9.87 in,8000 psi,pole_configuration_267462S,,,,,,,
pole_configuration,50.0 ft,7.5 ft,,8000 psi,pole_configuration_280565E,,,,,,,
pole_configuration,45.0 ft,6.5 ft,12.41 in,8000 psi,pole_configuration_306771E,,,,,,,
Expand Down
2 changes: 1 addition & 1 deletion converters/autotest/test_xls-spida2csv-geodata.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
class,pole_length,pole_depth,ground_diameter,fiber_strength,name,tilt_angle,tilt_direction,latitude,longitude,configuration,wind_speed,flags
class,pole_length,pole_depth,ground_diameter,fiber_strength,name,tilt_degree,tilt_direction,latitude,longitude,configuration,wind_speed,flags
pole_configuration,40.0 ft,5.5 ft,9.87 in,8000 psi,pole_configuration_267462S,,,,,,,
pole_configuration,50.0 ft,7.5 ft,12.18 in,8000 psi,pole_configuration_280565E,,,,,,,
pole_configuration,45.0 ft,6.5 ft,12.41 in,8000 psi,pole_configuration_306771E,,,,,,,
Expand Down
2 changes: 1 addition & 1 deletion converters/autotest/test_xls-spida2csv-network.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
class,pole_length,pole_depth,ground_diameter,fiber_strength,name,tilt_angle,tilt_direction,latitude,longitude,configuration,wind_speed,flags,equipment,parent,height,direction,pole_spacing,// cable_type,offset,area,weight,// equipment_type,phases,bustype,nominal_voltage,diameter,resistance,strength,distance_AE,conductor_A,spacing,from,to,length,connect_type,install_type,power_rating,primary_voltage,secondary_voltage,reactance
class,pole_length,pole_depth,ground_diameter,fiber_strength,name,tilt_degree,tilt_direction,latitude,longitude,configuration,wind_speed,flags,equipment,parent,height,direction,pole_spacing,// cable_type,offset,area,weight,// equipment_type,phases,bustype,nominal_voltage,diameter,resistance,strength,distance_AE,conductor_A,spacing,from,to,length,connect_type,install_type,power_rating,primary_voltage,secondary_voltage,reactance
pole_configuration,40.0 ft,5.5 ft,9.87 in,8000 psi,pole_configuration_267462S,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
pole_configuration,50.0 ft,7.5 ft,12.18 in,8000 psi,pole_configuration_280565E,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
pole_configuration,45.0 ft,6.5 ft,12.41 in,8000 psi,pole_configuration_306771E,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
Expand Down
2 changes: 1 addition & 1 deletion converters/mdb-cyme2glm.py
Original file line number Diff line number Diff line change
Expand Up @@ -2226,7 +2226,7 @@ def add_photovoltaic(self, photovoltaic_id, photovoltaic, version, **kwargs):
"panel_type": "MULTI_CRYSTAL_SILICON",
"efficiency": panel_efficiency,
"area": panel_area,
"tilt_angle": "45",
"tilt_degree": "45",
"orientation_azimuth": "180",
"orientation": "FIXED_AXIS",
}
Expand Down
Loading