-
Notifications
You must be signed in to change notification settings - Fork 6
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
Path to a revamped tutorial #292
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We have received multiple feedbacks about the current tutorial being somehow hard to undersand.
In addition it has some minor mistakes (
k_to_flux
andflux_to_k
are swapped), it currently fails to execute (see #286) and defaults tostandard
likelihood instead ofstandard_matrix
without any discussion on what is appropriate where (see #14).I have since try to address these points and I am ready to update the tutorial.
There are however a several situations where we need to over-explain things just because the way things are in
flarestack
is counter intuitive or still far from optimal:FLARESTACK_SCRATCH_DIR
seems to imply that the path will be exclusively used byflarestack
, but then everything is put under aflarestack__data
subdirectory meaningFLARESTACK_SCRATCH_DIR
should rather be a generic/shared scratch space;flarestack__data
andFLARESTACK_DATASET_DIR
;flarestack
module will trigger the creation of aflarestack__data
directory structure, I'd like myimports
to be read-only operations;name
, sometimesname
implies a path (such in the case of analyses, catalogues...)flarestack.shared.plot_output_dir
is a function rather than a variable, so it should better namedget_plot_output_dir()
;flarestack.utils.prepare_catalogue.ps_catalogue_name
has a rather obscure naming, something likecreate_catalogue
would be more understandable.The text was updated successfully, but these errors were encountered: