https://github.com/archspec/archspec
A library for detecting, labeling, and reasoning about microarchitectures
https://github.com/archspec/archspec
archspec microarchitectures python
Last synced: 4 months ago
JSON representation
A library for detecting, labeling, and reasoning about microarchitectures
- Host: GitHub
- URL: https://github.com/archspec/archspec
- Owner: archspec
- License: other
- Created: 2019-07-01T08:25:32.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-02-03T05:42:31.000Z (5 months ago)
- Last Synced: 2026-02-03T18:47:39.240Z (5 months ago)
- Topics: archspec, microarchitectures, python
- Language: Python
- Homepage: https://archspec.readthedocs.io/
- Size: 244 KB
- Stars: 125
- Watchers: 10
- Forks: 32
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Citation: CITATION.cff
- Notice: NOTICE
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
# Archspec (Python bindings)
[](https://github.com/archspec/archspec/actions)
[](https://codecov.io/gh/archspec/archspec)
[](https://archspec.readthedocs.io/en/latest/?badge=latest)
Archspec aims at providing a standard set of human-understandable labels for
various aspects of a system architecture like CPU, network fabrics, etc. and
APIs to detect, query and compare them.
This project grew out of [Spack](https://spack.io/) and is currently under
active development. At present it supports APIs to detect and model
compatibility relationships among different CPU microarchitectures.
## Getting started with development
The `archspec` Python package needs [poetry](https://python-poetry.org/) to
be installed from VCS sources. The preferred method to install it is via
its custom installer outside of any virtual environment:
```console
curl -sSL https://install.python-poetry.org | python3 -
```
You can refer to [Poetry's documentation](https://python-poetry.org/docs/#installation)
for further details or for other methods to install this tool. You'll also need `tox`
to run unit test:
```console
pip install --user tox
```
Finally, you'll need to clone the repository:
```console
git clone --recursive https://github.com/archspec/archspec.git
```
### Running unit tests
Once you have your environment ready you can run `archspec` unit tests
using ``tox`` from the root of the repository:
```console
$ tox
[ ... ]
py27: commands succeeded
py35: commands succeeded
py36: commands succeeded
py37: commands succeeded
py38: commands succeeded
pylint: commands succeeded
flake8: commands succeeded
black: commands succeeded
congratulations :)
```
## Citing Archspec
If you are referencing `archspec` in a publication, please cite the following
paper:
* Massimiliano Culpo, Gregory Becker, Carlos Eduardo Arango Gutierrez, Kenneth
Hoste, and Todd Gamblin.
[**`archspec`: A library for detecting, labeling, and reasoning about
microarchitectures**](https://tgamblin.github.io/pubs/archspec-canopie-hpc-2020.pdf).
In *2nd International Workshop on Containers and New Orchestration Paradigms
for Isolated Environments in HPC (CANOPIE-HPC'20)*, Online Event, November
12, 2020.
## License
Archspec is distributed under the terms of both the MIT license and the
Apache License (Version 2.0). Users may choose either license, at their
option.
All new contributions must be made under both the MIT and Apache-2.0
licenses.
See [LICENSE-MIT](https://github.com/archspec/archspec/blob/master/LICENSE-MIT),
[LICENSE-APACHE](https://github.com/archspec/archspec/blob/master/LICENSE-APACHE),
[COPYRIGHT](https://github.com/archspec/archspec/blob/master/COPYRIGHT), and
[NOTICE](https://github.com/archspec/archspec/blob/master/NOTICE) for details.
SPDX-License-Identifier: (Apache-2.0 OR MIT)
LLNL-CODE-811653