https://github.com/facebookresearch/clusterscope
Clusterscope is a CLI and python library to extract information from HPC Clusters and Jobs.
https://github.com/facebookresearch/clusterscope
ai ai-cluster ai-training hpc hpc-clusters hpc-systems slurm slurm-cluster slurm-job
Last synced: 8 days ago
JSON representation
Clusterscope is a CLI and python library to extract information from HPC Clusters and Jobs.
- Host: GitHub
- URL: https://github.com/facebookresearch/clusterscope
- Owner: facebookresearch
- License: mit
- Created: 2025-05-21T23:17:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-15T20:03:14.000Z (4 months ago)
- Last Synced: 2026-06-10T12:24:52.497Z (2 months ago)
- Topics: ai, ai-cluster, ai-training, hpc, hpc-clusters, hpc-systems, slurm, slurm-cluster, slurm-job
- Language: Python
- Homepage: https://facebookresearch.github.io/clusterscope/
- Size: 1.79 MB
- Stars: 24
- Watchers: 6
- Forks: 5
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Clusterscope
Clusterscope is a CLI and python library to extract information from HPC Clusters and Jobs.
Check out our [Website](https://facebookresearch.github.io/clusterscope/) for Getting Started and Documentation.
## Install from pypi
```bash
$ pip install clusterscope
```
You can use it as a python library:
```bash
$ python
>>> import clusterscope
>>> clusterscope.cluster()
''
```
You can also use it as a CLI:
```shell
$ 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](https://code.fb.com/codeofconduct)
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.fb.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
## Maintainers
clusterscope is actively maintained by [Lucca Bertoncini](https://github.com/luccabb), and [Kalyan Saladi](https://github.com/skalyan).
## Contributors
[Lucca Bertoncini](https://github.com/luccabb), [Kalyan Saladi](https://github.com/skalyan), [Nikhil Gupta](https://github.com/gunchu), [Misko Dzamba](https://github.com/misko),
### License
clusterscope is licensed under the [MIT](./LICENSE) 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}
}
```