search

mingrisch / compartmentmodels

Tracer-kinetic models for DCE MRI
BSD 3-Clause "New" or "Revised" License
5 stars 3 forks source link

Sphinx documentation #12

Open mingrisch opened 10 years ago

mingrisch commented 10 years ago

Major undertaking.

mingrisch commented 10 years ago

Ideally, we want a documentation on readthedocs that looks and feels much like, e.g. , the sandman documentation (jeffknupp/sandman on github). The outline should be:

Overview

Short and friendly description of this package.

Installation

Don't forget to mention platform-independency!

Example

Hands -on use case, possibly with an ipython notebook.

API documentation

This should be auto-generated by sphinx.

Invitation to contribute

There are some more models that could be included into this package. The DCE MRI community is cordially invited to contribute!

It might be necessary to describe in detail how to do this: learn python essentials, fork on github (get an account first, learn how to use git), learn how to use virtual environments, write test cases (read about test-driven development first), implement the new model, create a pull request and so on.