Skip to content

How to extend proteus

cekees edited this page Sep 16, 2011 · 4 revisions

How to extend proteus

13 Sep 2011

The idea is to add some model or numerical method without explicitly adding to or modifying the existing proteus package. The basic steps are:

  1. Create a github repository
  2. Create files and directories appropriate for a Python package:
/proteus-mhd
setup.py
README.rst
src/
test/
demo/

There is quite a bit of flexibility in the layout but it is a good idea to keep the source in one subdirectory, tests for automated testing in another, and full blown demos or benchmarks somewhere else. Examples (fairly messy at the moment) are https://github.com/erdc-cm/proteus-mprans, and https://github.com/erdc-cm/proteus-veg.