sundials

(β˜… 679)

Official development repository for SUNDIALS - a SUite of Nonlinear and DIfferential/ALgebraic equation Solvers. Pull requests are welcome for bug fixes and minor changes.

Showing a partial file list β€” download the zip above to see everything.

  • .clang-format
  • .clang-tidy
  • .claude
  • .cmake-format.py
  • .git-blame-ignore-revs
  • .gitignore
  • .gitmodules
  • .uberenv_config.json
  • AGENTS.md
  • CHANGELOG.md
  • CITATIONS.md
  • CLAUDE.md
  • CMakeLists.txt
  • CONTRIBUTING.md
  • LICENSE
  • NOTICE
  • pyproject.toml
  • README.md

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/llnl/sundials

Downloads the entire project code from GitHub to your computer.

cd sundials

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install sundials4py

Installs the package published on PyPI directly β€” no need to clone the source.

pip install git+https://github.com/llnl/sundials.git

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f docker/sundials-ci/e4s-base/Dockerfile -t sundials .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 sundials

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. CMake

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install sundials4py

Installs the package published on PyPI directly β€” no need to clone the source.

pip install git+https://github.com/llnl/sundials.git

Installs the package published on PyPI directly β€” no need to clone the source.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

6. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
cd doc

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation