Skip to main content

A cross-platform, high-throughput computing utility for processing shell commands over a distributed, asynchronous queue.

Project description

License Github Release PyPI Monthly Downloads Python Versions Code of Conduct Documentation Status

HyperShell is an elegant, cross-platform, high-throughput computing utility for processing shell commands over a distributed, asynchronous queue. It is a highly scalable workflow automation tool for many-task scenarios.

Built on Python and tested on Linux, macOS, and Windows.

Several tools offer similar functionality but not all together in a single tool with the user ergonomics we provide. Novel design elements include but are not limited to

  • Cross-platform: run on any platform where Python runs. In fact, the server and client can run on different platforms in the same cluster.

  • Client-server: workloads do not need to be monolithic. Run the server as a stand-alone service with SQLite or Postgres as a persistent database and dynamically scale clients as needed.

  • Staggered launch: At the largest scales (1000s of nodes, 100k+ of workers), the launch process can be challenging. Come up gradually to balance the workload.

  • Database in-the-loop: run in-memory for quick, ad-hoc workloads. Otherwise, include a database for persistence, recovery when restarting, and search.

Documentation

Documentation is available at hypershell.readthedocs.io. For basic usage information on the command line use: hs --help. For a more comprehensive usage guide on the command line you can view the manual page with man hs.

Contributions

Contributions are welcome. If you find bugs or have questions, open an Issue here. We’ve added a Code of Conduct recently, adapted from the Contributor Covenant, version 2.0.

Citation

If HyperShell has helped in your research please consider citing us.

@inproceedings{lentner_2022,
    author = {Lentner, Geoffrey and Gorenstein, Lev},
    title = {HyperShell v2: Distributed Task Execution for HPC},
    year = {2022},
    isbn = {9781450391610},
    publisher = {Association for Computing Machinery},
    url = {https://doi.org/10.1145/3491418.3535138},
    doi = {10.1145/3491418.3535138},
    booktitle = {Practice and Experience in Advanced Research Computing},
    articleno = {80},
    numpages = {3},
    series = {PEARC '22}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hypershell-2.7.1.tar.gz (3.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hypershell-2.7.1-py3-none-any.whl (103.9 kB view details)

Uploaded Python 3

File details

Details for the file hypershell-2.7.1.tar.gz.

File metadata

  • Download URL: hypershell-2.7.1.tar.gz
  • Upload date:
  • Size: 3.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.11

File hashes

Hashes for hypershell-2.7.1.tar.gz
Algorithm Hash digest
SHA256 e9a6eb56c2b17caaa5c0a46686980426e551310aa8e1c0ff86162b0a170011cd
MD5 2a02639b960db7c8c248a17d728d255e
BLAKE2b-256 3901855fb699bf5c4bf0beb9b0d467b6f2d05d85bcafdaab03d452e6abed7423

See more details on using hashes here.

File details

Details for the file hypershell-2.7.1-py3-none-any.whl.

File metadata

  • Download URL: hypershell-2.7.1-py3-none-any.whl
  • Upload date:
  • Size: 103.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.11

File hashes

Hashes for hypershell-2.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b582a8f798caa6fd2d3cc59ed441b5ae889d5a7d9697bd31b0e9f723b71a53cd
MD5 57a5e99cf2f936d87ae7bfc53f472e73
BLAKE2b-256 de3bd840b5c69e7bca2e0cfdf97b4bd048aae7203e15613bfcee8c93c6d0286f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page