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.

Sign up for GitHub

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

Jump to bottom

beeflow core info #908

Merged
merged 4 commits into from
Sep 4, 2024
Merged

beeflow core info #908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
22fa5a6
Add a way to get information about the current bee instance
aquan9 Aug 28, 2024
6ab3b31
Fix pyllama lint issues
aquan9 Aug 28, 2024
4983515
Add documentation
aquan9 Aug 28, 2024
ee4e44f
Update beeflow/client/core.py
aquan9 Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions beeflow/client/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,15 @@ def status():
print(f'{comp} ... {stat}')


@app.command()
def info():
"""Get information about beeflow's installation."""
version = importlib.metadata.version("hpc-beeflow")
print(f"Beeflow version: {version}")
print(f"bee_workflow directory: {paths.workdir()}")
print(f"Log path: {paths.log_path()}")


@app.command()
def stop(query='yes'):
"""Stop the current running beeflow daemon."""
Expand Down
2 changes: 2 additions & 0 deletions docs/sphinx/commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Options:

``beeflow core status``: Check the status of beeflow and the components.

``beeflow core info``: Get information about beeflow, including .beeflow directory location, log location, and version number.

``beeflow core stop``: Stop running beeflow components. Active workflows will be paused. You may continue running paused workflows with the ``beeflow resume <wf_id>`` command. Once you start beeflow components after a stop, you should check the status of workflows, query any running workflows. If they were intializing when a ``beeflow core stop`` was issued, the workflow may be running with tasks stuck in the waiting state. If this occurs and you want the workflow to continue pause and resume the workflow (``beeflow pause <wf_id>``, ``beeflow resume <wf_id>``) or to start over cancel the workflow (``beeflow cancel <wf_id>``) and resubmit it.

``beeflow core --version``: Display the version number of BEE.
Expand Down