build.sh

#!/bin/bash
# Copyright 2025 ResRipper.
# SPDX-License-Identifier: Apache-2.0

# Xyce build script
# Options:
#       - PARALLEL (boolen): Compile for MPI parallelism
#       - XYCE_VER (string): Xyce version to build

PARALLEL=${PARALLEL:-false}
XYCE_VER=${XYCE_VER:-7.10.0}

SUITESPARSE_INCLUDE=/usr/include/suitesparse

SCRIPT_PATH=$(dirname "$(readlink -f "${BASH_SOURCE[0]}")")
XYCE_SRC="${SCRIPT_PATH}/Xyce"
Trilinos_BIN="${SCRIPT_PATH}/Trilinos_bin"
BIN_PATH="${SCRIPT_PATH}/Xyce_bin"
mkdir -p "$BIN_PATH"

# Build config
BUILD_CONFIG=(
    -S "${XYCE_SRC}"
    -B "${XYCE_SRC}"/build
    -D CMAKE_INSTALL_PREFIX="${BIN_PATH}"

    -D Trilinos_ROOT="${Trilinos_BIN}"
    -D Xyce_PLUGIN_SUPPORT=ON
    -D Xyce_ROL=ON

    # # Test
    # '-D BUILD_TESTING=ON'
    # "-D Xyce_REGRESSION_DIR=${TEST_SUITE_PATH}"
    # '-D Xyce_GTEST_UNIT_TESTS=ON' # Enable Google Test
)

if [ "$PARALLEL" = true ]; then
    BUILD_CONFIG+=(
        -D CMAKE_C_COMPILER=mpicc
        -D CMAKE_CXX_COMPILER=mpicxx

        # Enable ShyLU
        -D Xyce_SHYLU=ON
        -D Xyce_AMESOS2_SHYLUBASKER=ON
    )
else
    BUILD_CONFIG+=(
        -D CMAKE_C_COMPILER=gcc
        -D CMAKE_CXX_COMPILER=g++
    )
fi

cd "$XYCE_SRC" && ./bootstrap

# Configure and build

## Import flags/options
source "${SCRIPT_PATH}/flags_var"
export CFLAGS="${C_FLAGS[*]} -I${SUITESPARSE_INCLUDE}"
export CXXFLAGS="${CXX_FLAGS[*]} -I${SUITESPARSE_INCLUDE}"
export LDFLAGS="${LD_FLAGS[*]}"

cmake \
    -D BUILD_SHARED_LIBS=ON \
    "${CMAKE_OPTS[@]}" "${BUILD_CONFIG[@]}" \
    || exit

cmake --build "${XYCE_SRC}"/build -j "$(nproc)" || exit

## Adjust installation path to comply with the FHS
if [ "$PARALLEL" = true ]; then
    sed -i 's|${XyceInstDir}/share|${XyceInstDir}/share/xyce-parallel|' "${XYCE_SRC}"/build/buildxyceplugin.sh
    sed -i 's|/usr/share|/usr/share/xyce-parallel|' "${XYCE_SRC}"/build/utils/XyceCInterface/SetupPythonEnv.m
    sed -i 's|${Xyce_DIR}/../../../share/|${Xyce_DIR}/../../../share/xyce-parallel|' "${XYCE_SRC}"/build/utils/ADMS/CMakeLists.txt
    sed -i 's|<Path to Xyce Install>/share|<Path to Xyce Install>/share/xyce-parallel|' "${XYCE_SRC}"/build/utils/ADMS/CMakeLists.txt
else
    sed -i 's|${XyceInstDir}/share|${XyceInstDir}/share/xyce-serial|' "${XYCE_SRC}"/build/buildxyceplugin.sh
    sed -i 's|/usr/share|/usr/share/xyce-serial|' "${XYCE_SRC}"/build/utils/XyceCInterface/SetupPythonEnv.m
    sed -i 's|${Xyce_DIR}/../../../share/|${Xyce_DIR}/../../../share/xyce-serial|' "${XYCE_SRC}"/build/utils/ADMS/CMakeLists.txt
    sed -i 's|<Path to Xyce Install>/share|<Path to Xyce Install>/share/xyce-serial|' "${XYCE_SRC}"/build/utils/ADMS/CMakeLists.txt
fi

python3 "${SCRIPT_PATH}"/replace_path.py "${XYCE_SRC}"/build

# Install to binary path
cmake --install "${XYCE_SRC}"/build --prefix "${BIN_PATH}"

# Build documentation

## Suppress latexmk output 
cd "${XYCE_SRC}" || exit
patch -p1 -i "${SCRIPT_PATH}"/patch/suppress_latexmk_RG.patch || exit
patch -p1 -i "${SCRIPT_PATH}"/patch/suppress_latexmk_UG.patch || exit

## Reference guide
cd "${XYCE_SRC}"/doc/Reference_Guide || exit
### Replace Sandia's internal class
sed -i 's|\\documentclass\[11pt,report\]{SANDreport}|\\documentclass\[11pt,letterpaper\]{scrreprt}|' Xyce_RG.tex
sed -i 's|\\usepackage\[sand\]{optional}|\\usepackage\[report\]{optional}|' Xyce_RG.tex
sed -i 's|\\SANDauthor{|\\author{|' Xyce_RG.tex
make

## User guide
cd "${XYCE_SRC}"/doc/Users_Guide || exit
### Replace Sandia's internal class
sed -i 's|\\documentclass\[11pt,report\]{SANDreport}|\\documentclass\[11pt,letterpaper\]{scrreprt}|' Xyce_UG.tex
sed -i 's|\\usepackage\[sand\]{optional}|\\usepackage\[report\]{optional}|' Xyce_UG.tex
sed -i 's|\\SANDauthor{|\\author{|' Xyce_UG.tex
make

# Move files
BUILD_TYPE='serial'
if [ "$PARALLEL" = true ]; then
    BUILD_TYPE='parallel'
fi

mkdir -p "${BIN_PATH}"/share/licenses/xyce-"${BUILD_TYPE}"

## License
mv "${BIN_PATH}"/share/doc/xyce-"${BUILD_TYPE}"/CPack.OSLicense.txt "${BIN_PATH}"/share/licenses/xyce-"${BUILD_TYPE}"/

## Doc

### Delete 'no pdf doc anymore' note
rm "${BIN_PATH}"/share/doc/xyce-"${BUILD_TYPE}"/README.TXT

mv "${XYCE_SRC}"/doc/Reference_Guide/Xyce_RG.pdf "${BIN_PATH}"/share/doc/xyce-"${BUILD_TYPE}"
mv "${XYCE_SRC}"/doc/Users_Guide/Xyce_UG.pdf "${BIN_PATH}"/share/doc/xyce-"${BUILD_TYPE}"

# Pack
if [ "$PARALLEL" = true ]; then
    tar -c \
    --zstd \
    -f "${SCRIPT_PATH}/xyce_parallel-${XYCE_VER}.tar.zst" \
    -C "${BIN_PATH}"/ .
else
    tar -c \
    --zstd \
    -f "${SCRIPT_PATH}/xyce_serial-${XYCE_VER}.tar.zst" \
    -C "${BIN_PATH}"/ .
fi