mingrisch / compartmentmodels

Tracer-kinetic models for DCE MRI

BSD 3-Clause "New" or "Revised" License

5 stars 3 forks source link

Structure #16

Closed mingrisch closed 9 years ago

mingrisch commented 9 years ago

how should this be packaged?

We would like to use

from compartmentmodels import GenericModel, Uptakemodel, ExchangeModel

how can we reflect this in the current package structure?

Look into the source code of similar packages, which need to be found first!

mingrisch commented 9 years ago

It appears that the solution is the following:

we use only the file compartmentmodels/compartmentmodels.py
this file will contain the following classes:
1. CompartmentModel (this is actually the class that is currently i) called GenericModel and ii)resides in GenericModel.py
2. CompartmentUptakeModel: A class that inherits from CompartmentModel a
3. TwoCompartmentExchangeModel: A class that inherits from CompartmentModel

In this way, we drop the unnecessary requirement of one file per class and we do not need to tinker with init.py files.