Skip to content

Example Folder Cleanup #351

Description

@jhalpern30

The examples folder is quite messy right now, with what seems to be a variety of both examples and benchmark-like cases. Some also contain their own run/analysis files, but others don't. A specific way I can see to clean this up and ensure a standard moving forward is removing the individual run scripts in each example folder in favor of a master script.

A rough sketch of how I see this working:
We make a master script RunExample.jl:

julia RunExample.jl "DIIID-like_ideal_example"

Within the main function of this file, it then checks the string passed in:

  • If it ends in "example" it basically does the existing run_example.jl few lines
  • If it ends in "scan" it does a generalized version of Daniel's run_scan.jl scripts

This would avoid having to maintain a run file for each example we maintain, and also force all examples conform to be either a "example" or "scan" type (or additional types as needed).

This doesn't account for example analysis scripts. We could add a generalized version of that too if needed

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    refactorBehavior-preserving restructuring

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions