This PR clearly separates the setup, build, and install actions for every supported platform. The PR involves a great deal of refactoring of source files, removal of unused or obsolete files, updated README files, and restructuring of the install target folder.
Scripts
[x] Prepare a system to build gridlabd:
./setup.sh --help
Use the --local option to install from the local repo. Otherwise, it will pull the setup script from slacgismo/gridlabd/master or from GRIDLABD_ORIGIN if it is exported.
[x] Run the complete build process:
./build.sh --help
Use the --system option to install for all system users. Use --clean to rebuild from scratch. Use --parallel to enable faster compilation.
[x] Install gridlabd from downloadable image file:
export INSTALL_SOURCE=https://install-dev.gridlabd.us
curl -sL https://raw.githubusercontent.com/dchassin/gridlabd/develop-fix-install/install.sh | sh
If you want regular users to run gridlabd, then do not install the downloadable image as root. Instead make sure the current user has permission to install applications, e.g., by belonging to a group with root permission. For example, on Ubuntu systems you can add the current user to the list sudoers with the command
su -c "echo $USER ALL=NOPASSWD: ALL >/etc/sudoers.d/$USER" root
Then you can install using sudo, give groups with root access permission to access the install, and add the user to the root access group e.g.,
Remember that changes in group membership don't take effect until you login again.
Depending on the group permissions setup of the host system, these specific command may differ, e.g., root access is granted through the group wheel or admin. In any case, users must have access to GridLAB-D's python virtual environments for build (~root/.gridlabd) and runtime (/usr/local/opt/gridlabd/current/bin/pkgenv) through group membership.
Supported platforms
[x] Darwin 22
[x] Darwin 21
[x] Darwin 20
[x] Ubuntu 22
[x] Ubuntu 20
[x] AWS EC2 (Ubuntu 22)
Additional tasks completed:
[x] Remove old build-aux scripts
[x] Update README.md
AWS uploads
You must have aws-cli installed and have valid AWS credentials to access install.gridlabd.us and install-dev.gridlabd.us. If you are working with a development branch, the uploads will be delivered to install-dev.gridlabd.us. If you are working on the master branch, they will be delivered to install.gridlabd.us.
[x] To create and upload an installable image to AWS use make aws-install.
[x] To make it the default AWS image, use make aws-install-default.
[x] To upload the AWS installer, use make aws-install.
Note: all instances of hipas have been changed back to slacgismo pending the transfer to arras-energy. However, instances in docker and .github that refer to dockerhub remain pending the changes to the CI/CD procedure that builds those images.
This PR clearly separates the setup, build, and install actions for every supported platform. The PR involves a great deal of refactoring of source files, removal of unused or obsolete files, updated README files, and restructuring of the install target folder.
Scripts
gridlabd:Use the
--localoption to install from the local repo. Otherwise, it will pull the setup script fromslacgismo/gridlabd/masteror fromGRIDLABD_ORIGINif it is exported.Use the
--systemoption to install for all system users. Use--cleanto rebuild from scratch. Use--parallelto enable faster compilation.gridlabdfrom downloadable image file:If you want regular users to run
gridlabd, then do not install the downloadable image asroot. Instead make sure the current user has permission to install applications, e.g., by belonging to a group withrootpermission. For example, on Ubuntu systems you can add the current user to the listsudoerswith the commandThen you can install using
sudo, give groups withrootaccess permission to access the install, and add the user to therootaccess group e.g.,Remember that changes in group membership don't take effect until you login again.
Depending on the group permissions setup of the host system, these specific command may differ, e.g.,
rootaccess is granted through the groupwheeloradmin. In any case, users must have access to GridLAB-D's python virtual environments for build (~root/.gridlabd) and runtime (/usr/local/opt/gridlabd/current/bin/pkgenv) through group membership.Supported platforms
Additional tasks completed:
build-auxscriptsREADME.mdAWS uploads
You must have
aws-cliinstalled and have valid AWS credentials to accessinstall.gridlabd.usandinstall-dev.gridlabd.us. If you are working with a development branch, the uploads will be delivered toinstall-dev.gridlabd.us. If you are working on themasterbranch, they will be delivered toinstall.gridlabd.us.make aws-install.make aws-install-default.make aws-install.Tips
Some Ubuntu installs bring up a dialog to confirm restarts system services after the daemons are upgraded to support GridLAB-D. To suppress this dialog and automatically restart the daemons, see https://askubuntu.com/questions/1367139/apt-get-upgrade-auto-restart-services.
Note: all instances of
hipashave been changed back toslacgismopending the transfer toarras-energy. However, instances indockerand.githubthat refer todockerhubremain pending the changes to the CI/CD procedure that builds those images.