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

Add entry point to the CLI app #119

Merged
merged 4 commits into from
Oct 26, 2024
Merged

Add entry point to the CLI app #119

merged 4 commits into from
Oct 26, 2024

Conversation

bobleesj
Copy link
Contributor

@bobleesj bobleesj commented Oct 25, 2024

imac@imacs-iMac diffpy.snmf % snmf --help       

                                          
usage: stretched_nmf [-h] [-i INPUT_DIRECTORY] [-o OUTPUT_DIRECTORY]
                     [-t {powder_diffraction,pd,pair_distribution_function,pdf}]
                     [-l LIFT_FACTOR] [-v]
                     number-of-components

Stretched Nonnegative Matrix Factorization

positional arguments:
  number-of-components  The number of component signals for the NMF decomposition. Must be
                        an integer greater than 0

options:
  -h, --help            show this help message and exit
  -i INPUT_DIRECTORY, --input-directory INPUT_DIRECTORY
                        Directory containing experimental data. Defaults to current working
                        directory.
  -o OUTPUT_DIRECTORY, --output-directory OUTPUT_DIRECTORY
                        The directory where the results will be written. Defaults to
                        '<input_directory>/snmf_results'.
  -t {powder_diffraction,pd,pair_distribution_function,pdf}, --data-type {powder_diffraction,pd,pair_distribution_function,pdf}
                        The type of the experimental data.
  -l LIFT_FACTOR, --lift-factor LIFT_FACTOR
                        The lifting factor. Data will be lifted by lifted_data = data +
                        abs(min(data) * lift). Default 1.
  -v, --version         Print the software version number

@bobleesj
Copy link
Contributor Author

@sbillinge Ready for review - will assist Filippo use CLI.

CI fails - diffpy.snmf still being pinned to 3.12 due to one of the convex optimization dependencies. but it has been tested locally.

Screenshot 2024-10-25 at 5 44 48 PM

@sbillinge
Copy link
Contributor

@sbillinge Ready for review - will assist Filippo use CLI.

CI fails - diffpy.snmf still being pinned to 3.12 due to one of the convex optimization dependencies. but it has been tested locally.

Screenshot 2024-10-25 at 5 44 48 PM

I believe there is an issue to remove that dependency

@bobleesj
Copy link
Contributor Author

I will try to remove the dependency in the next PR -

For now, could you please merge this?

This is to ensure Filippo can run the CLI since I am currently helping him get started.

@bobleesj
Copy link
Contributor Author

If there is any issue with our matrix CI Python 3.11, 3.12, I will bring it up.

@sbillinge sbillinge merged commit 8bc03e0 into diffpy:main Oct 26, 2024
2 of 3 checks passed
@sbillinge
Copy link
Contributor

ok, merged

@bobleesj bobleesj deleted the entry-point branch October 26, 2024 11:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants