Skip to content

Commit

Permalink
Fix product name
Browse files Browse the repository at this point in the history
commit b1e2ce2cbe7d20cbd42a50ea565879591c324c70
Author: David P. Chassin <[email protected]>
Date:   Fri Sep 22 13:04:19 2023 -0700

    Fix product name
  • Loading branch information
David P. Chassin committed Sep 22, 2023
1 parent 7e7d72b commit bb155d5
Show file tree
Hide file tree
Showing 32 changed files with 87 additions and 132 deletions.
9 changes: 6 additions & 3 deletions COPYRIGHT
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
HiPAS GridLAB-D Version 4.2
Copyright (C) 2020, Regents of the Leland Stanford Junior University
All Rights Reserved
Arras Energy Version 4.3
Copyright (C) 2023-, LF Energy

HiPAS GridLAB-D 4.1-4.2
Copyright (C) 2020-2022, Regents of the Leland Stanford Junior University

GridLAB-D Version 1.0-4.0
Copyright (C) 2004-2019, Battelle Memorial Institute
All Rights Reserved

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand Down
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
---

<div align=center><H3>IMPORTANT NOTICE</H3></div>

This is the last release of HiPAS GridLAB-D before it is transferred to LF Energy's [Arras Energy project](https://github.com/arras-energy).

---

| Repository | Build | Deploy |
| :---: | :---: | :---: |
Expand All @@ -19,13 +12,13 @@ This is the last release of HiPAS GridLAB-D before it is transferred to LF Energ

The documentation for this project is located at http://docs.gridlabd.us/.

This respository contains the source code to HiPAS GridLAB-D, which is being developed by SLAC National Accelerator Laboratory for the California Energy Commission under grant [EPC-17-046](https://www.energy.ca.gov/filebrowser/download/1147). This version of GridLAB-D is intended to be a commercial-grade version of the [US Department of Energy's research version of GridLAB-D developed by Pacific Northwest National Laboratory](https://github.com/gridlab-d/gridlab-d).
This respository contains the source code to Arras Energy, which is being developed by SLAC National Accelerator Laboratory for the California Energy Commission under grant [EPC-17-046](https://www.energy.ca.gov/filebrowser/download/1147). This version of GridLAB-D is intended to be a commercial-grade version of the [US Department of Energy's research version of GridLAB-D developed by Pacific Northwest National Laboratory](https://github.com/gridlab-d/gridlab-d).

*Note*: This fork of [GridLAB-D](https://github.com/gridlab-d/gridlab-d) does not support MS Windows directly. You must use docker or a virtual machine running linux.

# Quick start using Docker

The preferred method for running HiPAS GridLAB-D is to download the master image from docker hub (see https://hub.docker.com/repository/docker/arras-energy/gridlabd). You must install the docker daemon to use docker images. See https://www.docker.com/get-started for details.
The preferred method for running Arras Energy is to download the master image from docker hub (see https://hub.docker.com/repository/docker/arras-energy/gridlabd). You must install the docker daemon to use docker images. See https://www.docker.com/get-started for details.

Once you have installed docker, you may issue the following commands to run GridLAB-D at the command line:

Expand Down Expand Up @@ -86,7 +79,7 @@ Note that the installer only works with image name that conform to the name patt

# Build from source

The prerequesites for building HiPAS GridLAB-D from source include `git` and `curl`. In general you can use the `setup.sh` script to verify and update your system so that the prerequesites are satisifed.
The prerequesites for building Arras Energy from source include `git` and `curl`. In general you can use the `setup.sh` script to verify and update your system so that the prerequesites are satisifed.

On most systems, the process is as follows:

Expand Down Expand Up @@ -161,15 +154,15 @@ cd gridlabd

## Windows WSL

Generally, running HiPAS GridLAB-D on Docker is preferred because it is usually faster. Building, running and installing Gridlabd in WSL is not that different from a normal linux installation. You can follow Microsoft's instructions on setting up WSL and adding/changing distro's [here](https://learn.microsoft.com/en-us/windows/wsl/install). These instructions work for both cases on supported operating systems, which you can find in the build-aux directory.
Generally, running Arras Energy on Docker is preferred because it is usually faster. Building, running and installing Gridlabd in WSL is not that different from a normal linux installation. You can follow Microsoft's instructions on setting up WSL and adding/changing distro's [here](https://learn.microsoft.com/en-us/windows/wsl/install). These instructions work for both cases on supported operating systems, which you can find in the build-aux directory.

1) Open PowerShell as administrator or run the WSL (Ubuntu) from the start menu to open a dedicated terminal
2) Run `wsl` (Using Ubuntu)
3) Follow the Linux build procedure above.

## Manual Build

You can build HiPAS GridLAB-D manually by running following commands in the top level repository folder:
You can build Arras Energy manually by running following commands in the top level repository folder:

1. Create the target folder:

Expand Down
2 changes: 1 addition & 1 deletion build-aux/version.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
## --install the install folder path name, e.g., /usr/local/opt/gridlabd/4.3.1-230426-master-ubuntu_22-x86_64
## --name the install folder base name, /usr/local/opt/gridlabd/4.3.1-230426-master-ubuntu_22-x86_64
## --package the package name, e.g., gridlabd
## --package-name the package full name, e.g., HiPAS GridLAB-D
## --package-name the package full name, e.g., Arras Energy
## --machine the machine type, e.g., x86_64
## --system the system name, e.g., ubuntu_22
## --sysspec the system specification, e.g., ubuntu_22-x86_64
Expand Down
2 changes: 1 addition & 1 deletion cloud/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ Deliver version information.

# `www.gridlabd.us`

General landing page for HiPAS GridLAB-D.
General landing page for Arras Energy.
16 changes: 8 additions & 8 deletions cloud/websites/install.gridlabd.us/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,33 @@

<HEAD>

<TITLE>HiPAS GridLAB-D Online Installation & Validation</TITLE>
<TITLE>Arras Energy Online Installation & Validation</TITLE>

</HEAD>

<BODY>

<H1>HiPAS GridLAB-D Online Installation & Validation</H1>
<H1>Arras Energy Online Installation & Validation</H1>

<H2>Installing HiPAS GridLAB-D</H2>
<H2>Installing Arras Energy</H2>

<B>IMPORTANT:</B> This installer is designed to install HiPAS GridLAB-D on a new system image such as <CODE>wsl</CODE>, <CODE>ec2</CODE>, or <CODE>docker</CODE>. Do not use this on an existing system unless you are ok with significant changes to your system's build tools.
<B>IMPORTANT:</B> This installer is designed to install Arras Energy on a new system image such as <CODE>wsl</CODE>, <CODE>ec2</CODE>, or <CODE>docker</CODE>. Do not use this on an existing system unless you are ok with significant changes to your system's build tools.

<P/>

To install HiPAS GridLAB-D on your Linux or Mac system, type the following commands at a shell prompt:
To install Arras Energy on your Linux or Mac system, type the following commands at a shell prompt:

<P/>

<CODE>
bash$ curl -sL http://install.gridlabd.us/install.sh | sh
</CODE>

If your system is not supported by this installer, please use the manual installation method provided with the <A HREF="https://source.gridlabd.us/">HiPAS GridLAB-D source code</A>.
If your system is not supported by this installer, please use the manual installation method provided with the <A HREF="https://source.gridlabd.us/">Arras Energy source code</A>.

<H2>Validating HiPAS GridLAB-D</H2>
<H2>Validating Arras Energy</H2>

To validate your HiPAS GridLAB-D installation on your Linux or Mac system, type the following command at a shell prompt:
To validate your Arras Energy installation on your Linux or Mac system, type the following command at a shell prompt:

<P/>

Expand Down
4 changes: 2 additions & 2 deletions cloud/websites/status.gridlabd.us/index.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<HTML>
<HEAD>
<TITLE>GridLAB-D Status</TITLE>
<TITLE>Arras Energy Status</TITLE>
</HEAD>
<BODY>
<H1>HiPAS GridLAB-D Version 4.2 Development Status</H1>
<H1>Arras Energy Development Status</H1>
<H2>Development Version Top Links</H2>
<OL>
<LI><A HREF="http://docs.gridlabd.us/index.html?branch=develop">User manuals</A></LI>
Expand Down
4 changes: 2 additions & 2 deletions cloud/websites/tutorials.gridlabd.us/index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<HTML>

<HEAD>
<TITLE>HiPAS GridLAB-D Tutorials</TITLE>
<TITLE>Arras Energy Tutorials</TITLE>
<LINK REL="stylesheet" HREF="style.css" />
</HEAD>

Expand All @@ -24,7 +24,7 @@
<BODY>

<CENTER>
<H1>HiPAS GridLAB-D Training Video Library</H1>
<H1>Arras Energy Training Video Library</H1>
<VIDEO ID="player" HEIGHT="600" WIDTH="900" CONTROLS AUTOPLAY>Your browser does not support embedded video playbacks</VIDEO>
<BR/>
Session playing:
Expand Down
9 changes: 6 additions & 3 deletions configure.ac
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# File: configure.ac -*- Autoconf -*-
#
# GridLAB-D 4.0
# Copyright (C) 2008 Battelle Memorial Institute
# Copyright (C) 2008-2019 Battelle Memorial Institute
#
# HiPAS GridLAB-D 4.2
# Copyright (C) 2020 Regents of the Leland Stanford Junior University
# Copyright (C) 2020-2022 Regents of the Leland Stanford Junior University
#
# Arras Energy 4.3
# Copyright (C) 2023- LF Energy
#
# Authors:
# DP Chassin ([email protected])
Expand Down Expand Up @@ -624,7 +627,7 @@ fi
AC_MSG_RESULT([
-----------------------------------------------------------------------
HiPAS GridLAB-D Automatic configuration:
Arras Energy Automatic configuration:
Package: .................... $PACKAGE
Version: .................... $VERSION
Expand Down
2 changes: 1 addition & 1 deletion converters/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Converters

This folder contains the automatic file converters for HiPAS GridLAB-D.
This folder contains the automatic file converters for Arras Energy.

Converters are implement in a two-level paradigm. This top level implements
the file format converter based on the files' extensions. The second level
Expand Down
4 changes: 2 additions & 2 deletions docs/Cloud/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[/Cloud/README]] -- HiPAS GridLAB-D Cloud Support
[[/Cloud/README]] -- Arras Energy Cloud Support

HiPAS GridLAB-D was developed to support cloud operations. Currently the following cloud services are supported.
Arras Energy was developed to support cloud operations. Currently the following cloud services are supported.

* [[/Cloud/AWS]]
* [[/Cloud/Docker]]
Expand Down
2 changes: 1 addition & 1 deletion docs/Converters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ bash$ gridlabd -o <basename>.<ext> [-D <ext>_save_options='<options> ...']

# Description

HiPAS GridLAB-D automatically converts input and output files based on their extension and options provided, if any. In general each input and output extension has specific requirement for options to define how the file must be converted. Please see the documentation for the individual converters for details.
Arras Energy automatically converts input and output files based on their extension and options provided, if any. In general each input and output extension has specific requirement for options to define how the file must be converted. Please see the documentation for the individual converters for details.

# See also

Expand Down
8 changes: 4 additions & 4 deletions docs/Developers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Software developers and engineers are welcome to contribute to HiPAS GridLAB-D. The source code to HiPAS is available to the public through the [GitHub SLAC Gismo GridLAB-D project](https://source.gridlabd.us/).
Software developers and engineers are welcome to contribute to Arras Energy. The source code to HiPAS is available to the public through the [GitHub SLAC Gismo GridLAB-D project](https://source.gridlabd.us/).

## Developer Resources

Expand All @@ -9,9 +9,9 @@ Software developers and engineers are welcome to contribute to HiPAS GridLAB-D.
- [Wiki](https://source.gridlabd.us/wiki)
- [Discussions](https://source.gridlabd.us/discussions)

Developers should consult the [[/Developer/README]] for information about modifying and contributing to HiPAS GridLAB-D.
Developers should consult the [[/Developer/README]] for information about modifying and contributing to Arras Energy.

# Installing HiPAS GridLAB-D from source code
# Installing Arras Energy from source code

You can set up your system to host development and build GridLAB-D from source code using the installation script.

Expand All @@ -23,7 +23,7 @@ bash$ ./install.sh

This script supports the most common Linux/Unix platforms. If your platform is not supported, please consult the developer guide at [[/Developer/README]].

# Validating a HiPAS GridLAB-D installation
# Validating an Arras Energy installation

Once you have completed installation, you should validate your system before beginning software development.

Expand Down
16 changes: 8 additions & 8 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
Welcome to the user and modeling manuals for HiPAS GridLAB-D. The following manual sections are available in this branch.
Welcome to the user and modeling manuals for Arras Energy. The following manual sections are available in this branch.

# [Cloud](/index.html?folder=/Cloud)
*HiPAS GridLAB-D resources on the cloud using AWS, GitHub, and CircleCI*
*Arras Energy resources on the cloud using AWS, GitHub, and CircleCI*

# [Command](/index.html?folder=/Command)
*Command line options that change how HiPAS GridLAB-D works*
*Command line options that change how Arras Energy works*

# [Developer](/index.html?folder=/Developer)
*Develop guides for integrating and extending HiPAS GridLAB-D*
*Develop guides for integrating and extending Arras Energy*

# [GLM](/index.html?folder=/GLM)
*GLM is HiPAS GridLAB-D's powerful multi-domain modeling language*
*GLM is Arras Energy's powerful multi-domain modeling language*

# [Global](/index.html?folder=/Global)
*Variables that control features and environment of HiPAS GridLAB-D*
*Variables that control features and environment of Arras Energy*

# [Install](/index.html?folder=/Install)
*Installing HiPAS GridLAB-D on various platforms and system*
*Installing Arras Energy on various platforms and system*

# [Macro](/index.html?folder=/Macro)
*Macros control how GLM files are loaded and read*
Expand All @@ -28,7 +28,7 @@ Welcome to the user and modeling manuals for HiPAS GridLAB-D. The following manu
*Servers allow access to a simulation while it is running*

# [Subcommand](/index.html?folder=/Subcommand)
*Subcommand deliver extra features and extensions to HiPAS GridLAB-D*
*Subcommand deliver extra features and extensions to Arras Energy*

# [Tips and Tricks](http://docs-dev.gridlabd.us/_page.html?folder=/Tips%20and%20tricks)
*Lots of helpful hints and solutions to common problems*
2 changes: 1 addition & 1 deletion docs/Features.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The following features are new or improved in HiPAS GridLAB-D 4.2.
The following features are available in Arras Energy 4.3.

# Cloud

Expand Down
6 changes: 3 additions & 3 deletions docs/Home.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Welcome to the [HiPAS GridLAB-D](http://www.gridlabd.us/) documentation.
Welcome to the [Arras Energy](http://www.gridlabd.us/) documentation.

# [[/Features]]

*Learn the latest features of HiPAS GridLAB-D*
*Learn the latest features of Arras Energy*

# [[/Getting Started]]

*Get started using HiPAS GridLAB-D*
*Get started using Arras Energy*

# [[/Documentation]]

Expand Down
2 changes: 1 addition & 1 deletion docs/Module/Python/Tutorial.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

The `python` module allows HiPAS GridLAB-D models to be manipulated using Python code, and GridLAB-D simulations of those models to be controlled directly from Python.
The `python` module allows Arras Energy models to be manipulated using Python code, and GridLAB-D simulations of those models to be controlled directly from Python.

# Runtime Structure

Expand Down
4 changes: 0 additions & 4 deletions docs/News.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
# Technical Advisory Committee Meetings and User Workshops

The HiPAS GridLAB-D Technical Advisory Committee Meetings and User Workshops are held every September in Oakland California. Please see [Gridworks Distribution Systems Modeling Tools](https://gridworks.org/initiatives/distribution-system-modeling-tools/) for more information.

# Recent Updates

A list of recent releases of HiPAS GridLAB-D may be found at the [GitHub repository](https://source.gridlabd.us/discussions).
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# HiPAS GridLAB-D
# Arras Energy
*Brought to you by the [CEC EPIC Program](https://www.energy.ca.gov/programs-and-topics/programs/electric-program-investment-charge-epic-program)*<BR/>[image:cec-logo.png]

This documentation is for [HiPAS GridLAB-D](http://www.gridlabd.us/), the high-performance commercial release of GridLAB-D developed by Stanford University at SLAC National Accelerator Laboratory under funding from the California Energy Commission.
This documentation is for [Arras Energy](http://arras.energy/), the high-performance commercial release of GridLAB-D developed by Stanford University at SLAC National Accelerator Laboratory under funding from the California Energy Commission.

The documentation for the current research version of [GridLAB-D](https://www.gridlabd.org) developed by Battelle Memorial Institute at Pacific Northwest National Laboratory under funding from the US Department of Energy is available from [ShoutWiki](http://gridlab-d.shoutwiki.com/wiki/Main_Page).

4 changes: 2 additions & 2 deletions docs/Sponsors.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
HiPAS GridLAB-D was developed with funding from the following organizations:
Arras Energy was developed with funding from the following organizations:

# California Energy Commission EPIC Program
[image:cec-logo.png]

The current California version of GridLAB-D is called [HiPAS GridLAB-D](https://source.gridlabd.us/) and is managed by [Stanford University](https://www.stanford.edu/) at [SLAC National Accelerator Laboratory](https://slac.stanford.edu.) under funding from the [California Energy Commission](https://energy.ca.gov/) under the [Electric Program Investment Charge (EPIC) program](https://www.energy.ca.gov/programs-and-topics/programs/electric-program-investment-charge-epic-program).
The current California version of GridLAB-D is called [Arras Energy](https://arras.energy/) and is managed by [Stanford University](https://www.stanford.edu/) at [SLAC National Accelerator Laboratory](https://slac.stanford.edu.) under funding from the [California Energy Commission](https://energy.ca.gov/) under the [Electric Program Investment Charge (EPIC) program](https://www.energy.ca.gov/programs-and-topics/programs/electric-program-investment-charge-epic-program).

# US Department of Energy Office of Electricity
[image:doe-logo.png]
Expand Down
2 changes: 1 addition & 1 deletion docs/Subcommand/Insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Currently, the supported categories are

# Caveat

Collects version usage data for HiPAS GridLAB-D by year and month. If month
Collects version usage data for Arras Energy by year and month. If month
is not specified, then all months of the current year are returned. If year
is not specified, then all months of all years are returned.

Expand Down
4 changes: 2 additions & 2 deletions docs/Use cases/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[/Use cases/README]] -- HiPAS GridLAB-D Use-cases
[[/Use cases/README]] -- Arras Energy Use-cases

HiPAS GridLAB-D was developed to support a number of important new use-cases that have emerged as a result of California's greenhouse gas emissions goals. The following use-cases were identified for HiPAS GridLAB-D 4.2.
Arras Energy was developed to support a number of important new use-cases that have emerged as a result of California's greenhouse gas emissions goals. The following use-cases were identified for HiPAS GridLAB-D 4.2.

* [[/Use cases/Deep electrification]]
* [[/Use cases/Integration capacity analysis]]
Expand Down
2 changes: 1 addition & 1 deletion docs/User manual/0 - Cover/0 - Front matter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# HiPAS GridLAB-D 4.3 User's Manual
# Arras Energy 4.3 User's Manual

By David P. Chassin, SLAC National Accelerator Laboratory

Expand Down
2 changes: 1 addition & 1 deletion docs/User manual/0 - Cover/2 - Preface.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Preface

This manual is designed for general engineering, policy, regulatory, and economics readers who are interested in using HiPAS GridLAB-D to model and simulate the behavior of modern electricity delivery systems. Historically power system simulation tools were either solvers that could determine the power flow at a moment in time or the dynamic response for a short period of time, or they were simulators that were designed to produce verisimilar real-time behavior that is necessary for training operators and testing new hardware.
This manual is designed for general engineering, policy, regulatory, and economics readers who are interested in using Arras Energy to model and simulate the behavior of modern electricity delivery systems. Historically power system simulation tools were either solvers that could determine the power flow at a moment in time or the dynamic response for a short period of time, or they were simulators that were designed to produce verisimilar real-time behavior that is necessary for training operators and testing new hardware.

But the need to study and understand modern energy systems that are far more complex has given rise to a new generation of tools that can do more, including

Expand Down
2 changes: 1 addition & 1 deletion docs/_header.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# [HiPAS GridLAB-D 4.3](http://www.gridlabd.us/) User Documentation
# [Arras Energy](http://arras.energy/) User Documentation
## ((Home)) ((Features)) ((Getting Started)) ((Documentation)) ((Resources)) ((Developers)) ((Sponsors)) ((About Us)) ((News))
Loading

0 comments on commit bb155d5

Please sign in to comment.