search

LSSTDESC / rail_pipelines

Collection of RAIL-based data analysis pipelines
MIT License
0 stars 0 forks source link

Documentation distinguishing between .yml file pairs (file and file_config) #14

Open OliviaLynn opened 1 year ago

OliviaLynn commented 1 year ago

It would be nice if [the documentation] also explained the roles of the two .yml files with nearly the same name (and/or renamed one to disambiguate).

(from https://github.com/LSSTDESC/rail/issues/15#issuecomment-1590068252)

Putting this suggestion here, as I expect this to apply to pipelines in general (assuming they will all take on the pipeline.yml and pipeline_config.yml pattern).

aimalz commented 1 year ago

I think this would be resolved by the convention of *_pipe.yml to mirror *_config.yml (and just discovered a note to self to do this for the Golden Spike anyway).

eacharles commented 1 year ago

This comes from ceci, we should probably follow their conventions.On Aug 1, 2023, at 6:21 PM, Alex Malz @.**> wrote: I think this would be resolved by the convention of _pipe.yml to mirror *_config.yml (and just discovered a note to self to do this for the Golden Spike anyway).

—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you are subscribed to this thread.Message ID: @.***>

joezuntz commented 1 year ago

ceci takes these two files, but they can be called anything you like. I tend to call them pipeline.yml and config.yml though I know the latter in particular is not very descriptive. You could call it something else if you prefer.

There is documentation on the meaning of these two here:

https://ceci.readthedocs.io/en/latest/config.html#pipeline-yaml-files https://ceci.readthedocs.io/en/latest/config2.html#config2