search

thouska / spotpy

A Statistical Parameter Optimization Tool
https://spotpy.readthedocs.io/en/latest/
MIT License
254 stars 152 forks source link

Is there a code document to allow check all the classes and methods? #160

Open flydream0428 opened 6 years ago

flydream0428 commented 6 years ago

Something like this: https://modflowpy.github.io/flopydoc/mf.html

thouska commented 6 years ago

Thanks for this suggestion. So far, such a check is not implemented yet. However, it would be nice to have. Are you looking for something to check your spot_setup_class, so something like this? Or do you want to check the algorithm? This is currently under developement in form of a unittest

flydream0428 commented 6 years ago

Hi Tobias, Thanks for your reply. I am reading some scripts from a colleague. Then, I think it will be very useful to have a code document like the one I pointed to. You can just search the method/class in the document, then you can understand the code in a quick way. I am relatively new to Spotpy, but I see a great potential here. I hope I can contribute to this when I am more familiar with it. Cheers,