Skip to content
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

Output Folder Structure Cleanup #914

Open
yezr opened this issue Jan 9, 2025 · 2 comments
Open

Output Folder Structure Cleanup #914

yezr opened this issue Jan 9, 2025 · 2 comments
Assignees

Comments

@yezr
Copy link
Collaborator

yezr commented Jan 9, 2025

The current RCTab folder setup can be unintuitive for some users. We’ve added hashes and extra tabulate by slice options that can clutter the output folder. This ticket proposes a redesign to

  • Make it simple and easy for all users to see directly the round by round results first, with the option to navigate to more info (logs, hashes etc.) second
  • Distinguish more clearly .hash files from regular files
  • Distinguish more clearly separate tabulations of the same contest
image

Some notes

  • The top level output folder is still the one that is configured in RCTab.
  • Each run creates a new YYYY-MM-DD_HH-mm Results folder as a child to the parent output folder. Though unlikely, we must protect against collisions if more than one tabulation is run on the same minute. A solution could be appending _run2, _run3 to the tabulation folder name for subsequent runs within the same minute.
  • Open Results Folder button in RCTab after running tabulation should show the contents of the YYYY-MM-DD-HH-mm Results folder for that run
  • Open to changing checksums folder name/location if it would be easier in code to standardize it e.g. making any hash go into a Checksums folder in the current location
@yezr yezr added this to RCTab v2.0 Jan 9, 2025
@yezr yezr converted this from a draft issue Jan 9, 2025
@yezr yezr moved this to Todo in RCTab v2.0 Jan 9, 2025
@artoonie artoonie self-assigned this Jan 27, 2025
@artoonie artoonie moved this from Todo to In Progress in RCTab v2.0 Feb 20, 2025
@artoonie
Copy link
Collaborator

Thoughts on the root level checksums directory being YYYY-MM-DD_HH-mm Results Checksums instead of Checksums? That creates some consistency: all Checksums directories are [parent dir name] Checksums. Easier to code for one, as we don't need a special case, but I think also easier to parse for anyone automatically checking checksum code.

Also: thoughts on removing the space between the timestamp and "Results" in the root directory? Avoiding spaces in directory names is no longer necessary, but is still nice-to-have.

@yezr
Copy link
Collaborator Author

yezr commented Feb 26, 2025

Thoughts on the root level checksums directory being YYYY-MM-DD_HH-mm Results Checksums instead of Checksums? That creates some consistency: all Checksums directories are [parent dir name] Checksums. Easier to code for one, as we don't need a special case, but I think also easier to parse for anyone automatically checking checksum code.

So the name of each checksum folder has the entire parent folder name in it? Sounds good to me

Also: thoughts on removing the space between the timestamp and "Results" in the root directory? Avoiding spaces in directory names is no longer necessary, but is still nice-to-have.

The timestamps use both - and _ to delineate it's parts. For me, it is nice to have something different, the space, to delineate the timestamp and the folder description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

No branches or pull requests

2 participants