Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More overview documentation would be very helpful #133

Open
rjplevin opened this issue Jan 24, 2017 · 3 comments
Open

More overview documentation would be very helpful #133

rjplevin opened this issue Jan 24, 2017 · 3 comments

Comments

@rjplevin
Copy link

I may have missed it, but I haven't found documentation of the semantics of each method and its various outputs. I was hoping to not have to read all the original papers just to use the library.

The example at http:https://salib.readthedocs.io/en/latest/basics.html gives this kind of information for the Sobol' method. A similar discussion for the other methods, and a comparison of methods (which to use, when?) would also be helpful.

Thanks!

@willu47
Copy link
Member

willu47 commented Jan 25, 2017

Thanks for the feedback @rjplevin. I think this could go one of two ways. The methods themselves tend to be quite involved, despite the uniform interface that SALib provides to each of them, and understanding the sensitivity indices obtained from the methods requires some level of understanding of the methods - for which the papers may be the best source.

However, I'm definitely supportive of SALib becoming a not only easy to use, but also a source of new understanding about the methods and their similarities and differences. The question is how to go about this. As noted above, the interface to each of the methods is very similar - you could easily swap in Morris instead of Sobol in the example to which you provided a link. And a cursory description of the sensitivity indices is included in the docstrings of each of the methods. Could these be expanded to provide more information about interpretation?

@rjplevin
Copy link
Author

rjplevin commented Jan 27, 2017 via email

@willu47
Copy link
Member

willu47 commented Jun 16, 2017

Hi @rjplevin, I'm sorry I haven't replied sooner. There are some detailed questions here, and I think the easiest way to answer them is to direct you toward Saltelli's book from 2008,

Saltelli, ., M Ratto, T., Andres, F., Campolongo, J., Cariboni, D., Gatelli, M., Saisana, and S. Tarantola. Global Sensitivity Analysis: The Primer. 1st ed. John Wiley & Sons Ltd, 2008. ISBN: 978-0-470-05997-5

This book provides a general overview of variance based sensitivity analyses. Section 6.5 (pg 272) outlines which methods to use when and how long they take to run.

A good overview paper is (full disclosure: Jim Hall is my boss):

Pianosi, Francesca, Keith Beven, Jim Freer, Jim W. Hall, Jonathan Rougier, David B Stephenson, and Thorsten Wagener. Sensitivity Analysis of Environmental Models: A Systematic Review with Practical Workflow. Environmental Modelling & Software 79 (May 2016): 214–32. doi:10.1016/j.envsoft.2016.02.008.

On the whole, I'm supportive of collecting many of your suggestions into the library documentation. We just need to work out how to do it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants