Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 1.17 KB

README.md

File metadata and controls

25 lines (15 loc) · 1.17 KB

Build Status

ASYNCH

A numerical library for solving differential equations with a tree structure. Emphasis is given to hillslope-link river basin models.

Documentation

The documentation is available here. Thank you to the people running Read the Docs for such an excellent service.

The source for the documentation is in the docs folder. Here are the instructions to built and read it locally. The documentation is built with Doxygen and Sphinx. The sphinx template is from ReadtheDocs. Breathe provides a bridge between the Sphinx and Doxygen documentation systems.

pip install --user sphinx sphinx-autobuild sphinx_rtd_theme breathe recommonmark
apt-get doxygen

cd docs  
doxygen api.dox
doxygen devel.dox
make html

The html documentation is generated in docs/.build/html.

Testing

Asynch doesn't have a good test covergage at the moment but the unit test framework is in place.