Skip to content

Latest commit

 

History

History
159 lines (120 loc) · 5.69 KB

build.md

File metadata and controls

159 lines (120 loc) · 5.69 KB
Raw

Building IDAES Binaries

The build scripts are not intended for general use. IDAES users do not generally need to build IDAES binaries.

Aside from macOS the Linux and Windows builds use Docker, and I'll assume we are using Docker Desktop. The Linux ARM64 builds are done on macOS with Docker. Since Windows Docker containers require Windows, the x86_64 builds for Linux and Windows are done on Windows.

Build Environments

On Windows, except for one excpetion noted below the git Bash shell can be used.

Docker

  1. Install Docker Desktop.
  2. Get the docker files from https://github.com/IDAES/idaes-ext/tree/main/docker
  3. Go to the build-platform directory.
  4. From the a bash shell run sh build.sh {flavor} Replace {flavor} with the platform (el7, el8, ubuntu1804, ubuntu2004, ubuntu2204, or windows). On ARM64 there is no el7 or windows.
  • NOTE: If you are behind certain corporate firewalls/proxies, you will need to add lines to the beginning of the Dockerfiles for your SSL certificates.
  1. Usually testing is done by GitHub actions and the testing images are built on DockerHub, but ARM64 is not supported. If you need to build testing containers, go to the test-platform directory and run sh build.sh {platform}. The platform argument is slightly differnt than flavor. For testing it indicates a specific Linux distribution (or Windows).

macOS

Apple Silicon

  1. Install the Xcode command line tools
  2. Install cmake (cmake.org), and set it up to run from the command line
  3. Install homebrew and a few things:
  • brew install gcc
  • brew install pkgconfig
  • brew install boost
  • brew install bash

You only need to rebuild PETSc when you want to update to a new version. A recommended location for this is $HOME/src. For now, we compile without MPI, as we currently aren't aiming to do super computing.

  1. download https://petsc.org/release/download/
  2. extract in ~/src
  3. Go to PETSC source directory
  4. Configure PETSc (-fPIC is so we can use the Metis and Mumps builds again) ./configure --with-debug=0 --with-shared=0 --with-mpi=0 --with-fortran-bindings=0
    --download-metis --download-mumps --with-mumps-serial=1
    --prefix=$HOME/src/petsc-dist
  5. make
  6. make install

Intel

There is a GitHub Action, which does the build without HSL. If you want to build the IDAES extensions on an Intel Mac, the GitHub actions script may be a good refernce.

Building

Linux

On Winodws make sure Docker Desktop is set to Linux mode.

  1. Go to the build-extensions directory
  2. Put coinhsl.zip in the extras directoy if you have it
  3. In a bash shell (can use git bash on Windows) run sh build.sh {flavor} {arch}, where arch is x86_64 or aarch64.

Windows

The build.sh script does not work for the Windows build. There is a PowerShell script that will work. Make sure Docker Desktop is set to Windows mode (only works on Windows).

  1. Go to the build-extensions directory
  2. Put coinhsl.zip in the extras directoy if you have it
  3. In powershell run .\build.ps1 windows --no-cache

MacOS

  1. Checkout the idaes-ext repo.
  2. In the idaes-ext directory run the script to copy the source files to a new build location ( sh ./scripts/build_directory.sh ~/src/idaes-ext-build).
  3. Go to the build directory.

  4. bash ./scripts/compile_solvers.sh darwin

  5. bash ./scripts/compile_libs.sh darwin

  6. bash ./scripts/mac_collect.sh

Testing

x86 Windows and Linux

Testing is done with GitHub actions. There are container images on docker hub.

ARM64 Linux

There is a python script docker_linux_tests.sh in the idaes-ext/scripts directory. To run tests sh docker_linux_tests.sh {platform}. To help with debugging the test container is left after the script completes. You can run the container interactively if needed. Once done you will need to delete the container before running another test.

macOS

Apple Silicon

Test on clean VM for now, hopfully GitHub actions runners will be available soon.

Intel

There is a GitHub actions test.

Testing a non-default branch

By default, the Docker driver scripts (docker/build-extensions/build.sh and docker\build-extentions\build.ps1) checkout the main branch of https://github.com/idaes/idaes-ext.git to use for the build process. To test a different branch, arguments can be provided to the Docker driver scripts. For example, to test the ubuntu2204 build with a custom branch called mybranch on user's fork, run

./build.sh ubuntu2204 x86_64 https://github.com/user/idaes-ext.git mybranch

To test the Windows build, run

.\build.ps1 windows --no-cache https://github.com/user/idaes-ext.git mybranch

Note that the second argument to build.ps1 is interpreted as an argument to docker build, so to run with a custom branch and no such argument, run

.\build.ps1 windows "" https://github.com/user/idaes-ext.git mybranch

Release Hashes

Collect all the tar files for a release in the same directory.

With IDAES installed, run idaes hash-extensions --path <path to tar files> --release <release> A text file with the hash of all the files will be written to the directory with the release files.

Building without HSL

For testing purposes, it may be useful to build for multiple operating systems (via Docker) without HSL. This may be accomplished by passing the --without-hsl argument to docker/build-extensions/build.sh, after the OS name, architecture name, repository URL, and repository branch. This fifth positional argument to build.sh is interpreted as an argument (or arguments) to send to compile_solvers.sh. For example:

./build.sh ubuntu2204 x86_64 https://github.com/IDAES/idaes-ext.git main --without-hsl