Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.11 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.11 KB

Proteus: Computational Methods and Simulation Toolkit Build Status Binder DOI

Proteus (http://proteustoolkit.org) is a Python package for rapidly developing computer models and numerical methods.

Installation

The recommended way is the following:

make develop
make test

https://github.com/erdc/proteus/wiki/How-to-Build-Proteus-Using-HashDist

However, we are transitioning to a conda-based environment. Proteus can be installed with:

conda install proteus -c conda-forge

For a development installation, you want to install Proteus's dependencies and compile Proteus from source:

conda env create -f environment-dev.yml
conda activate proteus-dev
pip install -v -e .

Developer Information

The source code, wiki, and issue tracker are on GitHub at https://github.com/erdc/proteus.