{"id":22119591,"url":"https://github.com/pleiszenburg/scherbelberg","last_synced_at":"2025-06-15T12:38:42.846Z","repository":{"id":57464332,"uuid":"347986241","full_name":"pleiszenburg/scherbelberg","owner":"pleiszenburg","description":"HPC cluster deployment and management for the Hetzner Cloud","archived":false,"fork":false,"pushed_at":"2022-02-11T13:57:25.000Z","size":761,"stargazers_count":5,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-16T04:36:41.311Z","etag":null,"topics":["cloud","cluster","cluster-management","dask","dask-distributed","deployment","hetzner","high-performance","high-performance-computing","hpc","hpc-cluster","hpc-clusters","management","python"],"latest_commit_sha":null,"homepage":"https://scherbelberg.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pleiszenburg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-15T13:45:11.000Z","updated_at":"2024-04-26T13:39:02.000Z","dependencies_parsed_at":"2022-09-17T14:30:35.737Z","dependency_job_id":null,"html_url":"https://github.com/pleiszenburg/scherbelberg","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/pleiszenburg/scherbelberg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pleiszenburg%2Fscherbelberg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pleiszenburg%2Fscherbelberg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pleiszenburg%2Fscherbelberg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pleiszenburg%2Fscherbelberg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pleiszenburg","download_url":"https://codeload.github.com/pleiszenburg/scherbelberg/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pleiszenburg%2Fscherbelberg/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259977620,"owners_count":22941115,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud","cluster","cluster-management","dask","dask-distributed","deployment","hetzner","high-performance","high-performance-computing","hpc","hpc-cluster","hpc-clusters","management","python"],"created_at":"2024-12-01T14:15:58.533Z","updated_at":"2025-06-15T12:38:42.820Z","avatar_url":"https://github.com/pleiszenburg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![scherbelberg](docs/source/_static/logo01.png?raw=true)\n\n# SCHERBELBERG\n\n*/ˈʃɛʁbɛlbɛʁk/ ([German, toponym, male: \"mountain of shards\" in Leipzig](https://commons.wikimedia.org/wiki/Category:Rosentalh%C3%BCgel_(Leipzig)))*\n\n\u003c!-- [![build_master](https://github.com/pleiszenburg/scherbelberg/actions/workflows/test.yaml/badge.svg?branch=master \"Build Status: master / release\")](https://github.com/pleiszenburg/scherbelberg/actions/workflows/test.yaml) --\u003e\n[![docs_master](https://readthedocs.org/projects/scherbelberg/badge/?version=latest\u0026style=flat-square \"Documentation Status: master / release\")](https://scherbelberg.readthedocs.io/en/latest/)\n[![license](https://img.shields.io/pypi/l/scherbelberg.svg?style=flat-square \"BSD\")](https://github.com/pleiszenburg/scherbelberg/blob/master/LICENSE)\n[![status](https://img.shields.io/pypi/status/scherbelberg.svg?style=flat-square \"Project Development Status\")](https://github.com/pleiszenburg/scherbelberg/issues)\n[![pypi_version](https://img.shields.io/pypi/v/scherbelberg.svg?style=flat-square \"Project Development Status\")](https://pypi.python.org/pypi/scherbelberg)\n[![conda_version](https://img.shields.io/conda/vn/conda-forge/scherbelberg.svg?style=flat-square \"conda version\")](https://anaconda.org/conda-forge/scherbelberg)\n[![pypi_versions](https://img.shields.io/pypi/pyversions/scherbelberg.svg?style=flat-square \"Available on PyPi - the Python Package Index\")](https://pypi.python.org/pypi/scherbelberg)\n\u003c!-- [![chat](https://img.shields.io/matrix/zugbruecke:matrix.org.svg?style=flat-square \"Matrix Chat Room\")](https://matrix.to/#/#zugbruecke:matrix.org)\n[![mailing_list](https://img.shields.io/badge/mailing%20list-groups.io-8cbcd1.svg?style=flat-square \"Mailing List\")](https://groups.io/g/zugbruecke-dev) --\u003e\n\n## Synopsis\n\n`scherbelberg` provides both a CLI and an API for deploying and managing small [Dask](https://dask.org/)-based HPC clusters in the [Hetzner cloud](http://cloud.hetzner.com/). Development status *alpha*, stability *acceptable*, security also *acceptable* but implementation needs a review.\n\n## Project's Name\n\nNext to impressive projects like [Fugaku](https://en.wikipedia.org/wiki/Fugaku_(supercomputer)), which is named after [Mount Fuji](https://en.wikipedia.org/wiki/Mount_Fuji), the [TOP500](https://en.wikipedia.org/wiki/TOP500) are clearly missing an entry from the city of [Leipzig](https://en.wikipedia.org/wiki/Leipzig). This project is named after one of the few significant \"mountains\" in the city, the \"Scherbelberg\", also known as the \"[Rosentalhügel](https://commons.wikimedia.org/wiki/Category:Rosentalh%C3%BCgel_(Leipzig))\": 20 meters above the surrounding landscape and 125 meters above sea level. Starting out as a late 19th century landfill, it has since become part of a park-like landscape. As of 1975, a famously shaky steel [observation tower](https://commons.wikimedia.org/wiki/Category:Rosentalturm) with a rather [beautiful view](https://commons.wikimedia.org/wiki/Category:Views_from_Rosentalturm) is located at its top, overlooking not only the [Leipziger Auenwald](https://en.wikipedia.org/wiki/Leipzig_Riverside_Forest) forest but also the city's sewage treatment plant.\n\n## Installation\n\n`scherbelberg` can be installed via `conda` as follows:\n\n```bash\nconda install -c conda-forge scherbelberg\n```\n\nThis package has been tested on Linux and Windows 10. It should work on most Unix-like systems. You must run a `conda` environment based entirely on recent versions of [conda-forge](https://conda-forge.org/) packages with CPython versions 3.8, 3.9 or 3.10. ``ssh`` must be installed separately as a prerequisite. A [Hetzner API token](https://docs.hetzner.cloud/#getting-started) is required. By default, `scherbelberg` expects it to be located in the `HETZNER` environment variable.\n\nSee [chapter on installation](https://scherbelberg.readthedocs.io/en/latest/installation.html) in `scherbelberg`'s documentation for further details. Also see [section on how to get started](https://scherbelberg.readthedocs.io/en/latest/gettingstarted.html) for additional steps.\n\n## CLI\n\nSimilar to `git`, the CLI is divided into sub-commands. They all come with their own parameters. Information on the latter can be found by using the `--help` option.\n\n```\n~\u003e scherbelberg --help\nUsage: scherbelberg [OPTIONS] COMMAND [ARGS]...\n\n  HPC cluster deployment and management for the Hetzner Cloud\n\nOptions:\n  --version\n  --help     Show this message and exit.\n\nCommands:\n  catalog  list data centers and available servers types\n  create   create cluster\n  destroy  destroy cluster\n  ls       list cluster nodes\n  nuke     nuke cluster\n  scp      scp from/to cluster node\n  ssh      ssh into cluster node\n```\n\nSee [chapter on CLI](https://scherbelberg.readthedocs.io/en/latest/cli.html) in `scherbelberg`'s documentation for further details.\n\n## API\n\n`scherbelberg` uses `asyncio`. A cluster can basically be created and destroyed, with or without `asyncio`:\n\n```python\nfrom asyncio import run\nfrom scherbelberg import Cluster\n\nc = await Cluster.from_new(**kwargs)\n# or\nc = run(Cluster.from_new(**kwargs))\n\nawait c.destroy()\n# or\nrun(c.destroy())\n```\n\nAccess to an earlier established cluster can also be gained:\n\n```python\nfrom asyncio import run\nfrom scherbelberg import Cluster\n\nc = await Cluster.from_existing(**kwargs)\n# or\nc = run(Cluster.from_existing(**kwargs))\n```\n\nOnce the cluster has been created or gained access to, one can simply request an initialized Dask client object:\n\n```python\ndask_client = await c.get_client()\n# or\ndask_client = run(c.get_client(asynchronous = False))\n```\n\nSee [chapter on API](https://scherbelberg.readthedocs.io/en/latest/api.html) in `scherbelberg`'s documentation for further details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpleiszenburg%2Fscherbelberg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpleiszenburg%2Fscherbelberg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpleiszenburg%2Fscherbelberg/lists"}