GPU Acceleration & Build Changes

.gitignore

@@ -14,6 +14,8 @@ src/21cmFAST.egg-info/
 pip-wheel-metadata/
 src/py21cmfast\.egg-info/
 
+.python-version
+
 *.so
 build/
 *.*~

environment_dev.yml

@@ -8,7 +8,6 @@ dependencies:
   - zlib
   - pip
   - libxml2
-  - libffi
   - zipp
   - click
   - scipy
@@ -47,7 +46,6 @@ dependencies:
   - qt
   - packaging
   - ipython_genutils
-  - cffi
   - pytest-remotedata
   - nomkl
   - chardet
@@ -117,4 +115,4 @@ dependencies:
   - pytest-plt
   - questionary
   - pip:
-      - pre-commit
+    - pre-commit

install_custom.py

@@ -0,0 +1,72 @@
+#!/bin/python
+"""
+install_custom.py provides a custom installation process for the 21cmFAST package.
+
+Allows users to specify various build and configuration options via command-line arguments.
+
+Features:
+- Allows setting the log level for the installation process.
+- Provides an option to enable debug symbols for the build.
+- Enables customization of the optimization level for the build process.
+
+Command-line Arguments:
+- --log-level: Specifies the log level for the build process. Options include:
+    NO_LOG, ERROR, WARNING, INFO, DEBUG, SUPER_DEBUG, ULTRA_DEBUG. Defaults to WARNING.
+- --debug: Enables debug symbols for the build, which can be useful for debugging.
+- -o, --optimization: Sets the optimization level for the build (e.g., -O0, -O1, -O2, -O3).
+    Defaults to 3.
+
+Usage:
+Run the script from the command line to install 21cmFAST with the desired options:
+        python install_custom.py [options]
+
+Example:
+        python install_custom.py --log-level DEBUG --debug -o 2
+
+Dependencies:
+- Python 3.x
+- pip (Python package installer)
+
+Note:
+This script uses the `subprocess` module to invoke the `pip install` command with
+custom configuration settings.
+
+"""
+
+import argparse
+import subprocess
+
+# Define the command-line arguments
+parser = argparse.ArgumentParser(description="Install 21cmFAST with custom options.")
+parser.add_argument(
+    "--log-level",
+    type=str,
+    default="WARNING",
+    help="Set the log level (NO_LOG, ERROR, WARNING, INFO, DEBUG, SUPER_DEBUG, ULTRA_DEBUG)",
+)
+parser.add_argument("--debug", action="store_true", help="Enable debug symbols")
+parser.add_argument(
+    "-o",
+    "--optimization",
+    help="optimisation level (i,e -O0, -O1, -O2, -O3)",
+    default="3",
+)
+
+args = parser.parse_args()
+if args.optimization not in ["0", "g", "1", "2", "3", "s"]:
+    raise ValueError("Invalid optimization level. Choose from 0, g, 1, 2, 3 or s")
+
+# Get the LOG_LEVEL environment variable (default to 'WARNING' if not set)
+log_level_str = args.log_level
+setup_args = [
+    f"--config-setting=setup-args=-Dlog_level={log_level_str}",
+]
+
+debug = str(args.debug).lower()
+
+setup_args += [f"--config-setting=setup-args=-Ddebug={args.debug}"]
+setup_args += [f"--config-setting=setup-args=-Doptimization={args.optimization}"]
+
+
+# Run pip install with the specified options
+subprocess.run(["pip", "install", ".", *setup_args])

meson.build

@@ -0,0 +1,36 @@
+#To find the version we need to find python and run setuptools-scm, while keeping the project() call first
+project('21cmFAST', ['c', 'cpp'],
+   version : run_command(find_program('python'), '-c', 'from setuptools_scm import get_version; print(get_version())', check: true).stdout().strip(),
+   default_options : ['cpp_std=c++17'],
+)
+
+# Check if CUDA should be enabled after project declaration
+env_cuda_str = run_command('printenv', 'USE_CUDA', check: false).stdout().strip()
+if env_cuda_str == ''
+    env_cuda_flag = get_option('use_cuda')
+else
+    if env_cuda_str == 'TRUE'
+        env_cuda_flag = true
+    else
+        env_cuda_flag = false
+    endif
+endif
+
+nvcc_prog = find_program('nvcc', required: false)
+
+# Add CUDA language if both the environment variable is set AND nvcc is available
+if env_cuda_flag and nvcc_prog.found()
+  add_languages('cuda')
+  # For CUDA, we need to pass the C++ standard as a compiler argument since we're adding the language dynamically
+  add_project_arguments('--std=c++17', language: 'cuda')
+  message('CUDA enabled: nvcc found at ' + nvcc_prog.full_path())
+else
+  if env_cuda_flag and not nvcc_prog.found()
+    warning('USE_CUDA=TRUE but nvcc not found, building CPU-only version')
+  endif
+  message('Building CPU-only version')
+endif
+
+py = import('python').find_installation(pure: false)
+
+subdir('src')

meson.options

@@ -0,0 +1,3 @@
+# Define the log level option
+option('log_level', type: 'string', value: 'WARNING', description: 'Set the log level (e.g., NO_LOG, ERROR, WARNING, INFO, DEBUG, SUPER_DEBUG, ULTRA_DEBUG)')
+option('use_cuda',type: 'boolean', value: false, description: 'Attempt to find and use CUDA in the compilation if set to TRUE')