Clusterscope
Clusterscope is a CLI and python library to extract information from HPC Clusters and Jobs.
Check out our Website for Getting Started and Documentation.
Install from pypi
$ pip install clusterscope
You can use it as a python library:
$ python
>>> import clusterscope
>>> clusterscope.cluster()
'<your-cluster-name>'
You can also use it as a CLI:
$ cscope
Usage: cscope [OPTIONS] COMMAND [ARGS]...
Command-line tool to query Slurm cluster information.
Options:
--help Show this message and exit.
Commands:
aws Check if running on AWS and show NCCL settings.
check-gpu Check if a specific GPU type exists.
cpus Show CPU counts per node.
gpus Show GPU information.
info Show basic cluster information.
job-gen Generate job requirements for different job types.
mem Show memory information per node.
version Show the version of clusterscope.
Contributing
Read our contributing guide to learn about our development process, how to propose bugfixes and feature requests, and how to build your changes.
Code of Conduct
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Maintainers
clusterscope is actively maintained by Lucca Bertoncini, and Kalyan Saladi.
Contributors
Lucca Bertoncini, Kalyan Saladi, Nikhil Gupta, Misko Dzamba,
License
clusterscope is licensed under the MIT license.
Citing Clusterscope
@Misc{
author = {Lucca Bertoncini, and Kalyan Saladi},
title = {Clusterscope - Tooling for extracting HPC Cluster and Jobs information. },
howpublished = {Github},
year = {2025},
url = {https://github.com/facebookresearch/clusterscope}
}
1 maintainer
Release files for clusterscope 0.0.32
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| clusterscope-0.0.32.tar.gz | 319.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| clusterscope-0.0.32-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 341.4 kB
Release files / clusterscope-0.0.32.tar.gz
| Download URL | clusterscope-0.0.32.tar.gz |
|---|---|
| Size | 319.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b702f528f69aacf0e1dc56383ac3a39b52e7f385563c2d878a462fc4bcea0e29
|
|
BLAKE2b-256 checksum How to use checksums |
8635d2129eb61d230d03b6285da7653ff1ce1b5f4c5058b1e26acd24cce1e276
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
Release files / clusterscope-0.0.32-py3-none-any.whl
| Download URL | clusterscope-0.0.32-py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
20a4915a09ccbd70edd50f71993b77f2c401d0b4c9d913947ff0a30471f2387e
|
|
BLAKE2b-256 checksum How to use checksums |
4db609eb1ba9b549c8afd6942d69a678708d971b6d6c847ed8d8cce7e55aef22
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.14
|
