Enable Axom's Python to be installed via uv/pip #1936
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ install- | |
| .project | ||
| .settings | ||
| build-* | ||
| build/ | ||
| install-* | ||
| _axom_build_and_test_* | ||
| *.pyc | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| #!/bin/bash | ||
| ############################################################################## | ||
| # Copyright (c) Lawrence Livermore National Security, LLC and other | ||
| # Axom Project Contributors. See top-level LICENSE and COPYRIGHT | ||
| # files for dates and other details. | ||
| # | ||
| # SPDX-License-Identifier: (BSD-3-Clause) | ||
| ############################################################################## | ||
|
|
||
| # Build the thin, pip/uv-installable Axom wheel and exercise it end to end, | ||
| # without using the run_python_with_axom.sh wrapper or updating the PYTHONPATH: | ||
| # | ||
| # 1. build the wheel from src/python against the prebuilt Axom install | ||
| # specified by AXOM_DIR or AXOM_INSTALL (find_package(axom)); | ||
| # 2. install the wheel into a fresh uv venv; | ||
| # 3. verify the wheel installed conduit.pth for the same-build Conduit python module; | ||
| # 4. run the Sidre Python test suite with plain pytest. | ||
| # | ||
| # Intended for the gcc docker image, which is nanobind-enabled. | ||
|
|
||
| # Fail on the first error, including inside pipelines, and trace every command so | ||
| # a CI failure is readable from the log alone. | ||
| set -e | ||
| set -o pipefail | ||
| set -x | ||
|
|
||
| HOST_CONFIG="${HOST_CONFIG:-host-configs/docker/gcc@13.3.1.cmake}" | ||
|
|
||
| echo "~~~~ helpful info ~~~~" | ||
| echo "USER=$(id -u -n)" | ||
| echo "PWD=$(pwd)" | ||
| echo "HOST_CONFIG=${HOST_CONFIG}" | ||
| echo "~~~~~~~~~~~~~~~~~~~~~~" | ||
|
|
||
| absolute_path() { | ||
| local path="$1" | ||
| if [[ ! -e "${path}" ]]; then | ||
| echo "ERROR: Path does not exist: ${path}" >&2 | ||
| return 1 | ||
| fi | ||
| local dir | ||
| local base | ||
| dir=$(dirname "${path}") | ||
| base=$(basename "${path}") | ||
| printf "%s/%s" "$(cd "${dir}" && pwd -P)" "${base}" | ||
| } | ||
|
|
||
| if [[ ! -f "${HOST_CONFIG}" ]]; then | ||
| echo "ERROR: Host-config not found: ${HOST_CONFIG}" >&2 | ||
| exit 1 | ||
| fi | ||
| HOST_CONFIG_PATH=$(absolute_path "${HOST_CONFIG}") | ||
| echo "HOST_CONFIG_PATH=${HOST_CONFIG_PATH}" | ||
|
|
||
| # extract value from host-config line of the form `set(${name} ON CACHE BOOL "")` | ||
| # then capitalizes it and looks for true-like patterns | ||
| cmake_bool_from_file_is_on() { | ||
| local name="$1" | ||
| local value | ||
| value=$(awk -v name="${name}" ' | ||
| $0 ~ "set\\(" name "[ \t\"]+" { | ||
| line = $0 | ||
| sub("^[ \t]*set\\(" name "[ \t\"]+", "", line) | ||
| sub("[ \t\"\\)].*$", "", line) | ||
| print line | ||
| exit | ||
| } | ||
| ' "${HOST_CONFIG_PATH}") | ||
| value="${value^^}" | ||
| [[ "${value}" == "ON" || "${value}" == "TRUE" || "${value}" == "YES" || "${value}" == "1" ]] | ||
| } | ||
|
|
||
| if [[ -n "${AXOM_INSTALL:-}" && -z "${AXOM_DIR:-}" ]]; then | ||
| AXOM_DIR="${AXOM_INSTALL%/}/lib/cmake" | ||
| fi | ||
|
|
||
| if [[ -z "${AXOM_DIR:-}" || ! -f "${AXOM_DIR}/axom-config.cmake" ]]; then | ||
| echo "ERROR: Axom CMake package not found." >&2 | ||
| echo " Set AXOM_DIR to the directory containing axom-config.cmake," >&2 | ||
| echo " or set AXOM_INSTALL to an Axom install prefix." >&2 | ||
| exit 1 | ||
| fi | ||
| AXOM_DIR=$(absolute_path "${AXOM_DIR}") | ||
| echo "AXOM_DIR=${AXOM_DIR}" | ||
|
|
||
| AXOM_WHEEL_ENABLE_MPI=OFF | ||
| if cmake_bool_from_file_is_on ENABLE_MPI; then | ||
| AXOM_WHEEL_ENABLE_MPI=ON | ||
| fi | ||
| echo "AXOM_WHEEL_ENABLE_MPI=${AXOM_WHEEL_ENABLE_MPI}" | ||
|
|
||
| echo "~~~~~~ ENSURE uv IS AVAILABLE ~~~~~~" | ||
| if ! command -v uv >/dev/null 2>&1; then | ||
| # Distro Pythons (e.g. Ubuntu 24.04) ship a PEP 668 EXTERNALLY-MANAGED marker, which makes `pip install --user` fail. | ||
|
Member
There was a problem hiding this comment. was this something you hit or randomly injected by codex?
Member
Author
There was a problem hiding this comment. A little bit of both (?) I did run into the problem where |
||
| # uv only lands in the user site directory so opting out is safe here. | ||
| pip_args="--user" | ||
| if python3 -c 'import os, sysconfig, sys; sys.exit(0 if os.path.exists(os.path.join(sysconfig.get_path("stdlib"), "EXTERNALLY-MANAGED")) else 1)'; then | ||
| pip_args="${pip_args} --break-system-packages" | ||
| fi | ||
| python3 -m pip install ${pip_args} uv | ||
| export PATH="${HOME}/.local/bin:${PATH}" | ||
| fi | ||
| uv --version | ||
|
|
||
| echo "~~~~~~ BUILD THE THIN WHEEL FROM src/python ~~~~~~" | ||
| # Point find_package at the install with AXOM_DIR | ||
| # Conduit resolves transitively from axom's config, which records its Conduit prefix | ||
| rm -rf dist | ||
| uv build --wheel \ | ||
| -C cmake.args=-C \ | ||
| -C "cmake.args=${HOST_CONFIG_PATH}" \ | ||
| -C "cmake.define.AXOM_DIR=${AXOM_DIR}" \ | ||
| --out-dir dist \ | ||
| src/python | ||
| ls -l dist | ||
| AXOM_WHEEL=$(find dist -maxdepth 1 -name 'axom-*.whl' -print -quit) | ||
| if [[ -z "${AXOM_WHEEL}" ]]; then | ||
| echo "ERROR: Axom wheel not found in dist/." | ||
| exit 1 | ||
| fi | ||
|
|
||
| echo "~~~~~~ FRESH VENV + INSTALL THE WHEEL ~~~~~~" | ||
| # Pin the interpreter that built the wheel, so the venv cannot pick a different one. | ||
| VENV_DIR=/tmp/axom-wheel-venv | ||
| rm -rf "${VENV_DIR}" | ||
| uv venv --python "$(command -v python3)" "${VENV_DIR}" | ||
| VENV_PY="${VENV_DIR}/bin/python" | ||
| AXOM_WHEEL_EXTRAS="test" | ||
| if [[ "${AXOM_WHEEL_ENABLE_MPI}" == "ON" ]]; then | ||
| AXOM_WHEEL_EXTRAS="test,mpi" | ||
| fi | ||
| uv pip install --python "${VENV_PY}" "${AXOM_WHEEL}[${AXOM_WHEEL_EXTRAS}]" | ||
|
|
||
| echo "~~~~~~ VERIFY WHEEL-INSTALLED CONDUIT .pth ~~~~~~" | ||
| PLATLIB=$("${VENV_PY}" -c 'import sysconfig; print(sysconfig.get_paths()["platlib"])') | ||
| CONDUIT_PTH="${PLATLIB}/conduit.pth" | ||
| if [[ ! -f "${CONDUIT_PTH}" ]]; then | ||
| echo "ERROR: Expected wheel to install ${CONDUIT_PTH}." | ||
| echo " The wheel should expose the same-build Conduit python module without a manual PYTHONPATH update." | ||
| exit 1 | ||
| fi | ||
| CONDUIT_PY_DIR=$(sed -n '1p' "${CONDUIT_PTH}") | ||
| if [[ -z "${CONDUIT_PY_DIR}" || ! -d "${CONDUIT_PY_DIR}" ]]; then | ||
| echo "ERROR: ${CONDUIT_PTH} points to missing Conduit python module directory '${CONDUIT_PY_DIR}'." | ||
| exit 1 | ||
| fi | ||
| echo "verified ${CONDUIT_PTH} -> ${CONDUIT_PY_DIR}" | ||
|
|
||
| echo "~~~~~~ IMPORT SMOKE TEST ~~~~~~" | ||
| "${VENV_PY}" -c \ | ||
| "import axom, axom.sidre, conduit, numpy; print('axom', axom.__version__); print('axom.sidre', axom.sidre.__version__)" | ||
| if [[ "${AXOM_WHEEL_ENABLE_MPI}" == "ON" ]]; then | ||
| "${VENV_PY}" -c "import mpi4py, axom.sidre as sidre; assert sidre.AXOM_ENABLE_MPI" | ||
| else | ||
| "${VENV_PY}" -c "import axom.sidre as sidre; assert not sidre.AXOM_ENABLE_MPI" | ||
| fi | ||
|
|
||
| echo "~~~~~~ RUN THE SIDRE PYTHON SUITE VIA PLAIN pytest ~~~~~~" | ||
| # Axom's Python tests are named *_Py.py, which pytest's default python_files patterns do not match | ||
| TEST_DIR="$(pwd)/src/axom/sidre/tests" | ||
| SCRATCH="$(mktemp -d)" | ||
| pushd "${SCRATCH}" > /dev/null | ||
| "${VENV_PY}" -m pytest -s -p no:cacheprovider \ | ||
| -o python_files='*_Py.py' \ | ||
| "${TEST_DIR}" | ||
| popd > /dev/null | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally I would just fail if it is not set.