hpc-beeflow 0.1.11.dev5
A software package for containerizing HPC applications and managing job workflows
Requires Python: <=3.14,>=3.11
Keywords: bee, hpc, workflow, cluster, computing

BEE: Build and Execution Environment
************************************

Coverage in Develop

.. image:: https://github.com/lanl/BEE/raw/develop/coverage.svg
   :alt: Coverage Badge for develop

Coverage in Main

.. image:: https://github.com/lanl/BEE/raw/main/coverage.svg
   :alt: Coverage Badge for main

BEE is a workflow orchestration system designed to build containerized HPC applications and orchestrate workflows across HPC and cloud systems. BEE has adopted the Common Workflow Language (`CWL <https://www.commonwl.org/>`_) for specifying workflows. Complex scientific workflows specified by CWL are managed and visualized through a graph database, giving the user the ability to monitor the state of each task in the workflow. BEE runs jobs using the workload scheduler (i.e. Slurm or Flux) on the HPC system that tasks are specified to run on.

BEE workflows can be archived for provenance and reproducibility. BEE can orchestrate workflows with containerized applications or those built locally on a system. However, there are advantages to containerizing an application.

A container is a package of code (usually binaries) and all of that code's dependencies (libraries, etc.). Once built, this container can be run on many different platforms.

Containers provide many benefits:

* Users can choose their own software stack (libraries, compilers, etc.) and not be bound by the currently installed environment on any one machine.

* Codes can be run portably across numerous platforms--all dependencies will be downloaded and installed at run time.

* Entire **workflow** environments can be built into one or more containers. A user can include visualization and analysis tools along with the application. They will all work together as the application runs.

* Provenance and history can be tracked by storing containers in a historical repository. At any time, an older container can be rerun (all of its dependencies are stored with it). Execution is repeatable and interactions between software components can be tracked.

* Functional testing can be performed on smaller, dissimilar machines--there is no real need to test on the actual HPC platform (performance testing obviously requires target hardware).


BEE Sites
=========

* Github: `https://github.com/lanl/BEE <https://github.com/lanl/BEE>`_


* PyPi: `https://pypi.org/project/hpc-beeflow/ <https://pypi.org/project/hpc-beeflow/>`_

.. list-table:: 
   :header-rows: 1
   :widths: 20 25 55

   * - Purpose
     - Git Tag
     - Documentation

   * - Stable release
     - ``0.1.10``
     - `https://lanl.github.io/BEE/ <https://lanl.github.io/BEE/>`__
   * - Pre-release
     - ``0.1.11dev5``
     - `https://lanl.github.io/BEE/0.1.11dev5/ <https://lanl.github.io/BEE/0.1.11dev5/>`__


Contact
=======


For bugs and problems report, suggestions and other general questions regarding the BEE project, email questions to `bee-dev@lanl.gov <bee-dev@lanl.gov>`_.


Contributors:
==========================

* Steven Anaya - `Boogie3D <https://github.com/Boogie3D>`_
* Paul Bryant - `paulbry <https://github.com/paulbry>`_
* Rusty Davis - `rstyd <https://github.com/rstyd>`_
* Jieyang Chen - `JieyangChen7 <https://github.com/JieyangChen7>`_
* Krishna Chilleri - `Krishna Chilleri <https://github.com/kchilleri>`_
* Patricia Grubel - `pagrubel <https://github.com/pagrubel>`_
* Qiang Guan - `guanxyz <https://github.com/guanxyz>`_
* Ragini Gupta - `raginigupta6 <https://github.com/raginigupta6>`_
* Aaron R Hall - `arhall0 <https://github.com/arhall0>`_
* Leah Howell - `Leahh02 <https://github.com/Leahh02>`_
* Lilikoi Latimer - `lilikoi-l <https://github.com/lilikoi-l>`_
* Andres Quan - `aquan9 <https://github.com/aquan9>`_
* Quincy Wofford - `qwofford <https://github.com/qwofford>`_
* Tim Randles - `trandles-lanl <https://github.com/trandles-lanl>`_
* Jacob Tronge - `jtronge <https://github.com/jtronge>`_
* Kabir Vats - `kabir-vats <https://github.com/kabir-vats>`_
* Sare Beste Zeytun - `sbzeytun <https://github.com/sbzeytun>`_
* Jeff Tamashiro - `jeffreyt <https://github.com/jeffreyt>`_
* Wesley Mason - `wmason-lanl <https://github.com/wmason-lanl>`_

Concept and Design Contributors

* James Ahrens
* Curt Canada 
* Allen McPherson
* Li-Ta Lo
* Louis Vernon


Contributing
==========================

The BEE project adheres to style guidelines specified in `setup.cfg <https://github.com/lanl/BEE/blob/master/setup\.cfg>`_. Before attempting to commit and push changes, please install our pre-commit githooks by running the following command in project root:

If using `git --version` >= 2.9:
    git config core.hooksPath .githooks

Otherwise:
    cp .githooks/* .git/hooks/

Using these git hooks will ensure your contributions adhere to style guidelines required for contribution. You will need to repeat these steps for every `BEE` repo you clone.


Release
==========================

This software has been approved for open source release and has been assigned **BEE C17056**.

Copyright
==========================
License can be found `here <https://github.com/lanl/BEE/blob/master/LICENSE>`_


Publications
==========================

- An HPC-Container Based Continuous Integration Tool for Detecting Scaling and Performance Issues in HPC Applications, IEEE Transactions on Services Computing, 2024, `DOI: 10.1109/TSC.2023.3337662 <https://doi.ieeecomputersociety.org/10.1109/TSC.2023.3337662>`_
- BEE Orchestrator: Running Complex Scientific Workflows on Multiple Systems, HiPC, 2021, `DOI: 10.1109/HiPC53243.2021.00052 <https://doi.org/10.1109/HiPC53243.2021.00052>`_
- "BeeSwarm: Enabling Parallel Scaling Performance Measurement in Continuous Integration for HPC Applications", ASE, 2021, `DOI: 10.1109/ASE51524.2021.9678805 <https://www.computer.org/csdl/proceedings-article/ase/2021/033700b136/1AjTjgnW2pa#:~:text=10.1109/ASE51524.2021.9678805>`_
- "BeeFlow: A Workflow Management System for In Situ Processing across HPC and Cloud Systems", ICDCS, 2018, `DOI: 10.1109/ICDCS.2018.00103 <https://ieeexplore.ieee.org/abstract/document/8416366>`_
- "Build and execution environment (BEE): an encapsulated environment enabling HPC applications running everywhere", IEEE BigData, 2018, `DOI: 10.1109/BigData.2018.8622572 <https://ieeexplore.ieee.org/document/8622572>`_