Place of py example scripts

acerbilab / pybads

PyBADS: Bayesian Adaptive Direct Search optimization algorithm for model fitting in Python

https://acerbilab.github.io/pybads/

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

67 stars 2 forks source link

Place of py example scripts #16

Closed pipme closed 1 year ago

pipme commented 1 year ago

In example notebooks, the links to full code like pybads_example_1_basic_usage.py are not correct. The py scripts are now in tests/bads/examples/.

Maybe it's better to place these examples scripts to ./examples/ or ./examples/scripts? Since they are not actually part of tests.

lacerbi commented 1 year ago

They were moved by mistake, probably a misunderstanding. I told @GurjeetSinghSangra to move the scripts he uses as tests to tests, but I didn't mean the scripts of the public examples. I would indeed move the public examples .py files to ./examples/scripts or ./examples/src (I don't know what's the standard name for source folder in Python). Let's use the same convention as in PyVBMC.

GurjeetSinghSangra commented 1 year ago

Yes it was a misunderstanding I thought that you wanted to hide them all from users. I moved the pybads_examples_* into ./examples/scripts directory.

lacerbi commented 1 year ago

Did you also fix the links from the notebooks? Each notebook at the end links to the pure Python script.

GurjeetSinghSangra commented 1 year ago

Updated, and tested all the examples, making a PR.

pipme commented 1 year ago

Fixed in #19.