Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carstenbauer/sysinfo.jl
What does my system look like?
https://github.com/carstenbauer/sysinfo.jl
Last synced: about 1 month ago
JSON representation
What does my system look like?
- Host: GitHub
- URL: https://github.com/carstenbauer/sysinfo.jl
- Owner: carstenbauer
- License: mit
- Created: 2024-07-16T17:40:38.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-11T18:21:22.000Z (5 months ago)
- Last Synced: 2024-10-13T22:32:24.356Z (2 months ago)
- Language: Julia
- Homepage:
- Size: 204 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SysInfo
[](https://github.com/carstenbauer/SysInfo.jl/actions/workflows/CI.yml?query=branch%3Amain)
This package is the backend of [ThreadPinning.jl](https://github.com/carstenbauer/ThreadPinning.jl). However, you may use it directly to obtain core information about the compute system at hand (number of physical cores, NUMA domains, etc.).
## Features
* Get a compact summary of the system (topology and key figures).
* Query various properties of the system, including the number of CPU-threads, physical CPU-cores, and NUMA domains.
* Supports identifying different CPU-core kinds (e.g. "efficiency core" and "performance cores").
* Two backends: [Hwloc.jl](https://github.com/JuliaParallel/Hwloc.jl) and `lscpu`.
* Fake mode: Simulate being on a different system (useful in conjuction with [ThreadPinningCore.jl](https://github.com/carstenbauer/ThreadPinningCore.jl)'s fake mode).
## Usage
On a Perlmutter (NERSC) login node:
```julia-repl
julia> using SysInfo
julia> sysinfo() # only exported function
Hostname: login19
CPU(s): 2 x AMD EPYC 7713 64-Core Processor
CPU target: znver3
Cores: 128 (256 CPU-threads due to 2-way SMT)
NUMA domains: 8 (16 cores each)
∘ CPU 1:
→ 64 cores (128 CPU-threads due to 2-way SMT)
→ 4 NUMA domains
∘ CPU 2:
→ 64 cores (128 CPU-threads due to 2-way SMT)
→ 4 NUMA domains
Detected GPUs: 1
julia> SysInfo.ncores() # programmatic access, public API but not exported
128
julia> SysInfo.ncputhreads()
256
julia> SysInfo.nsockets()
2
julia> SysInfo.nnuma()
8
```
On a Mac mini M1:
```julia-repl
julia> sysinfo()
Hostname: pc2macmini.fritz.box
CPU(s): 1 x Apple M1
CPU target: apple-m1
∘ CPU 1:
→ 8 cores (8 CPU-threads)
→ 4 "efficiency cores", 4 "performance cores".
→ 1 NUMA domain
```
## Backends
SysInfo.jl uses [Hwloc.jl](https://github.com/JuliaParallel/Hwloc.jl) as the source of truth. It also has a `lscpu`-based backend that can be used as a replacement or for consistency checks (at least on Linux).
## API
See [api.jl](src/api.jl) and the `@public`/`export` markers in [SysInfo.jl](src/SysInfo.jl).
## Adding your system as a "test system"
We fake-run the test suite of this package on a bunch of interesting systems (e.g. with interesting CPUs or topologies). **You can readily add your interesting system to the list**, which helps us ensure that this package (as well as [ThreadPinning.jl](https://github.com/carstenbauer/ThreadPinning.jl)) is working on your system.
(Please only add your system if you think it is worth testing on.)
### How?
On the desired system, run
```julia
SysInfo.TestSystems.dump_current_system("NameOfYourSystem")
```
This will create a folder `NameOfYourSystem` in the current directory which you should then add to the `testsystems` directory of this repository (via a pull request).
**Thank you in advance!**