Skip to content

fix: update command-line interface to be more user-friendly #204

@cadenmyers13

Description

@cadenmyers13

Problem

The CLI is challenging to work with and Gooey builds the GUI in a way thats hard to navigate. lets make it more user friendly

Proposed solution

Update the style to the following commands.

labpdfproc # launches gui
labpdfproc mud <xray-data-path> <mud value>
labpdfproc zscan <xray-data-path> <z-scan-data-path>
labpdfproc sample <xray-data-path> --composition <comp> --energy <x-ray energy or source> --density <sample density>

Each subcommand has the options -f to force overwrite an existing file and -t to specify a target directory.

We also want to save metadata, so each subcommand has the options --username, --orcid --email which adds this info as metadata in the corrected data. this is to build a database of corrected data for future use.

Lastly, copy and paste the code located in the comment below to src/diffpy/labpdfproc/labpdfprocapp.py. This is chatgpt generated code and it has bugs when it comes to using the functions correctly, but the cli commands will build.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions