Welcome to The Linux Foundation's Arras Energy Project
The documentation for this project is located at http://docs.gridlabd.us/.
This organization contains the source code and support repositories to Arras Energy, which was developed by SLAC National Accelerator Laboratory for the California Energy Commission under grant EPC-17-046. This version of GridLAB-D is a commercial-grade version of the US Department of Energy's research version of GridLAB-D developed by Pacific Northwest National Laboratory.
Note: This fork of GridLAB-D does not support MS Windows directly. You must use docker or a virtual machine running linux.
The following options are available for using Arras Energy:
Run on GitHub
You can run Arras Energy with GitHub Actions using the template https://github.com/gridlabd-tutorials/.new_project. The simulation results are stored in a downloadable file that can accessed from the
Actions tab in your GitHub project. A tutorial for using Arras Energy with GitHub is available at https://github.com/gridlabd-tutorials.
Run on Docker
docker run -it -v $PWD:/model lfenergy/arras:latest gridlabd -W /model [LOADOPTIONS] [FILENAME.EXT] [RUNOPTIONS]
See Dockerhub HiPAS repositories for a list of available images.
Run on AWS
- Sign into your AWS console.
- Launch an EC2 instance.
- Search the community AMI for images starting with
us-west-1(N. California) region.
- Choose an instance type with sufficient memory, e.g., >4GB.
- Download and save your keypair.
- Launch the instance.
- Connect to the instance.
- Download your model into the instance, e.g., from GitHub.
- Run the simulation using the usual command line options.
- Save the results, e.g., to GitHub.
You can also start the instance from the command line:
aws ec2 run-instances --image-id AMINAME --count 1 --instance-type INSTANCETYPE --key-name KEYPAIRNAME --security-group-ids SECURITYGROUPID --subnet-id SUBNETID
You can search the AWS AMI Catalog for Community AMIs matching "Arras Energy HiPAS GridLAB-D" in the
us-west-1 region. The version number will be included in the name.
Download on Mac, Windows WSL, or Ubuntu Linux
curl -sL https://install.gridlabd.us/install.sh | [sudo] sh
Build your own
git clone https://source.gridlabd.us/ [-b BRANCH] gridlabd cd gridlabd ./setup.sh --local ./build.sh --system --validate
Access remote resources
HiPAS GridLAB-D requires access to many remote resources. To ensure that access is possible, please verify that your site supports the HiPAS GridLAB-D cybersecurity plan.
Current Project Status
|Benchmarks||Manual test (see README.md)|
|Examples||Manual test (see README.md)|
|Lesson 1||Create a GitHub project, download a reference model, solve powerflow, and plot a voltage profile.|
|Lesson 2||Modify, create, and delete static loads.|
|Lesson 3||Create distributed generation resources such as rooftop solar, wind, and backup generators.|
|Lesson 4||Create energy storage devices such as residential wall-mount batteries and community energy storage|
|Lesson 5||Running simulations over time|
|Lesson 6||Managing weather|
|Lesson 7||Adding quasi-static loads|
|Lesson 8||Exporting data|
|Lesson 9||Importing data|