LSSTDESC / rail_attic

Redshift Assessment Infrastructure Layers
MIT License
14 stars 9 forks source link

General cleanup questions #320

Closed OliviaLynn closed 1 year ago

OliviaLynn commented 1 year ago

Inconsistent use of data and configs directories

There are inconsistencies in the existence/use of data/ and configs/ directories in each directory in RAIL/src/rail.

  configs in ./ configs in ./configs/ data in ./ data in ./data/
RAIL/src/rail/examples/creation x yes x yes
RAIL/src/rail/examples/estimation x x yes yes
RAIL/src/rail/examples/goldenspike yes x x yes

We aso have some stray configs outside of src/rail, such as RAIL/examples/core/pipe_example_config.yml.

Pipelines directory

Currently, is has its own .gitignore containing just *.*~, and nothing else in RAIL seems to use it.

Attic

There's an attic directory at RAIL/examples/goldenspike/attic/.

It seems to create at least a nonzero amount of maintainability work; I've noticed Drew had to update a couple of the utils in his PR deprecating Brier and PIT.

The name attic implies a place for old/unused things, but this seems like a directory that lets the user interact with goldenspike outside of a notebook.

Misc