Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create version 4.3.3 #1

Closed
wants to merge 5 commits into from
Closed
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
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
13 changes: 12 additions & 1 deletion Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
# Authors:
# DP Chassin ([email protected])

.SILENT:

$(info Current target is $(shell $(top_srcdir)/build-aux/version.sh --name))

# !!! must match version specified in configure.ac
Expand Down Expand Up @@ -50,13 +52,15 @@ AM_LDFLAGS += -module
AM_LDFLAGS += -avoid-version
AM_LDFLAGS += -export-dynamic
AM_LDFLAGS += $(GLD_LDFLAGS) -lpython$(PYVER)
AM_LIBTOOLFLAGS = --quiet

# makefile fragments populate these variables
BUILT_SOURCES =
CLEANFILES =
EXTRA_DIST =
dist_pkgdata_DATA = requirements.txt
pkgdata_DATA =
pkginclude_HEADERS =
noinst_LTLIBRARIES =
pkglib_LTLIBRARIES =
bin_PROGRAMS =
Expand Down Expand Up @@ -291,11 +295,18 @@ $(PREFIX)/docker.img: docker/Dockerfile Makefile
@mkdir -p $(prefix)
docker save $(PACKAGE)/$(PACKAGE_VERSION)-$(PACKAGE_BRANCH):latest -o $(prefix)/docker.img

system: python-install install
system: python-install install $(prefix)/src
@echo "Setting $$($(top_srcdir)/build-aux/version.sh --install) to the current system version"
@$(prefix)/bin/gridlabd version set
@test "$$(gridlabd --version=install)" = "$$($(top_srcdir)/build-aux/version.sh --install)" || echo 'WARNING : build and install versions differ; use build `--clean` option to fix this problem'

$(prefix)/src:
@echo Copying source files to $@...
@mkdir -p $(prefix)/src/source $(prefix)/src/python
@cp $(top_srcdir)/source/*.cpp $(prefix)/src/source
@cp $(top_srcdir)/python/*.cpp $(prefix)/src/python
@chmod -R 555 $(prefix)/src

index: weather library template

html-local: module-html developer-html troubleshooting-html
Expand Down
21 changes: 7 additions & 14 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,24 +12,24 @@ 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:

~~~
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 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 build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ test -f $HOME/.gridlabd/bin/activate || error "$HOME/.gridlabd is not found. Run
test ! -z "$VIRTUAL_ENV" || . $HOME/.gridlabd/bin/activate 1>$STDOUT 2>$STDERR
test ! -z "$VIRTUAL_ENV" || error "unable to activate gridlabd venv"
test -f ./configure || autoreconf -isf 1>$STDOUT 2>$STDERR || error "autoconf failed"
test -f Makefile || ./configure $CONFIGURE 1>$STDOUT 2>$STDERR || error "./configure failed"
test -f Makefile || ./configure --enable-silent-rules $CONFIGURE 1>$STDOUT 2>$STDERR || error "./configure failed"
make $MAKEFLAGS $TARGET 1>$STDOUT 2>$STDERR || error "unable to make build"
if [ ! -z "$VERIFY" ]; then
$(build-aux/version.sh --install)/bin/gridlabd $VERIFY 1>$STDOUT 2>$STDERR || error "unable to verify install"
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.
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>
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
10 changes: 7 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 @@ -54,6 +57,7 @@ AC_CONFIG_AUX_DIR([build-aux])
###############################################################################

AM_INIT_AUTOMAKE([foreign subdir-objects -Wall])
AM_SILENT_RULES([yes])
m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES])

###############################################################################
Expand Down Expand Up @@ -623,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
Loading
Loading