proteus

(β˜… 96)

A computational methods and simulation toolkit

File Explorer

Download Latest Version (.zip)
  • .coveragerc
  • .gitattributes
  • .gitignore
  • .gitmodules
  • .travis.yml
  • codecov.yml
  • CONTRIBUTING.md
  • CONTRIBUTORS.md
  • dev_env.sh
  • dev_env_mike.sh
  • environment-dev-up.yml
  • environment-dev.yml
  • environment-petsc-dev.yml
  • environment.yml
  • index.ipynb
  • INTRODUCTION
  • LICENSE.md
  • Makefile
  • MANIFEST.in
  • petsc-dev.yml
  • pyproject.toml
  • README.md
  • RELEASE.md
  • setup.py

# Installation Guide

1. Get the code
git clone https://github.com/erdc/proteus

Downloads the entire project code from GitHub to your computer.

cd proteus

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 -v -e .

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

pip install setuptools make cmake cython swig pybind11 numpy

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/conda/Dockerfile -t proteus .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 proteus

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. 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 -v -e .

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

python -m venv petsc-dev

Runs the Python script (or module).

pip install setuptools make cmake cython swig pybind11 numpy

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

CC=mpicc CXX=mpicxx MPI_DIR=$MPI_ROOT pip install -v mpi4py==3.1.6 --no-build-isolation --no-binary=:all:

Installs the Python libraries listed in requirements.txt (or similar).

PETSC_DIR=$CONDA_PREFIX PETSC_ARCH="" pip install -v ../petsc/src/binding/petsc4py --no-build-isolation --no-binary=:all:

Installs the Python libraries listed in requirements.txt (or similar).

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

Pulled directly from this repo's README.

5. 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).
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.

Today's picks

angular β˜… 101,004

Deliver web apps with confidence πŸš€

TypeScript
deno β˜… 108,275

A modern runtime for JavaScript and TypeScript.

Rust
tech-interview-handbook β˜… 142,052

Curated coding interview preparation materials for busy software engineers

TypeScript
PayloadsAllTheThings β˜… 80,236

A list of useful payloads and bypass for Web Application Security and Pentest/CTF

Python
cs-video-courses β˜… 83,137

List of Computer Science courses with video lectures.
pi β˜… 94,938

AI agent toolkit: unified LLM API, agent loop, TUI, coding agent CLI

TypeScript
// repository documentation