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

Modify or remove get-examples for new repo #1138

Merged
merged 10 commits into from
Mar 31, 2023

Conversation

dangunter
Copy link
Member

Fixes #1131

Summary/Motivation:

Not really needed anymore

Changes proposed in this PR:

  • Play around with variations on removing or making the command a print statement
  • Commit the best solution

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@dangunter dangunter self-assigned this Mar 16, 2023
@dangunter
Copy link
Member Author

New command

❯ idaes --help
Usage: idaes [OPTIONS] COMMAND [ARGS]...

Options:
  --version      Show the version and exit.
  -v, --verbose  Increase verbosity. Show warnings if given once, then info,
                 and then debugging messages.
  -q, --quiet    Increase quietness. If given once, only show critical
                 messages. If given twice, show no messages.
  --help         Show this message and exit.

Commands:
  bin-directory       Show IDAES executable file directory
  bin-platform        Show the compatible binary build.
  config-display      Show IDAES config
  config-file         Show the config file paths
  config-set          Set a set a configuration option
  config-write        Write the IDAES config
  convergence-eval    Run convergence sample evaluation.
  convergence-sample  Create a convergence sample file.
  convergence-search  Search for convergence test classes.
  copyright           Show IDAES copyright information
  data-directory      Show IDAES data directory
  environment-info    Print information about idaes, OS, dependencies...
  extensions-license  show license info for binary extensions
  extensions-version  show license info for binary extensions
  get-examples        (legacy) install IDAES example Jupyter notebooks
  get-extensions      Get solvers and libraries
  hash-extensions     Calculate release hashes
  import-time         Show how long it takes to import command modules
❯ idaes get-examples

The get-examples command has been removed.

The IDAES examples are now available as the `idaes-examples` package in PyPI.
To install, run the following command:

     pip install idaes-examples

This also installs the 'idaesx' command that can be used to browse the Jupyter
notebooks. The simplest way to do this is with the embedded desktop UI:

    idaesx gui

For more details, see the IDAES documentation at https://idaes-pse.readthedocs.io/
and the idaes-examples page on PyPI at https://pypi.org/project/idaes-examples/

@dangunter dangunter requested a review from eslickj as a code owner March 16, 2023 16:21
@ksbeattie ksbeattie added the Priority:High High Priority Issue or PR label Mar 16, 2023
@codecov
Copy link

codecov bot commented Mar 16, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.42 🎉

Comparison is base (cd2605c) 76.32% compared to head (c7292ed) 76.74%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1138      +/-   ##
==========================================
+ Coverage   76.32%   76.74%   +0.42%     
==========================================
  Files         370      372       +2     
  Lines       60214    60011     -203     
  Branches    10961    10922      -39     
==========================================
+ Hits        45957    46055      +98     
+ Misses      11903    11598     -305     
- Partials     2354     2358       +4     
Impacted Files Coverage Δ
idaes/commands/examples.py 100.00% <100.00%> (+77.35%) ⬆️

... and 8 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Copy link
Member

@ksbeattie ksbeattie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@lbianchi-lbl lbianchi-lbl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should get #1132 merged soon, but this is self-documenting enough that I think we can merge it concurrently.

@lbianchi-lbl lbianchi-lbl enabled auto-merge (squash) March 31, 2023 17:34
@lbianchi-lbl lbianchi-lbl merged commit 5f734af into IDAES:main Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority:High High Priority Issue or PR
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Use IDAES/examples instead of IDAES/examples-pse
3 participants