Skip to content

pulp-platform/chimera-sdk

Repository files navigation

CHIMERA SDK

Chimera-SDK is a bare-metal development platform for ASICs based on the Chimera architecture, a microcontroller SoC for multi-cluster, heterogeneous systems.

Chimera and Chimera-SDK are developed as part of the PULP project, a joint effort between ETH Zurich and the University of Bologna.

Documentation

All revelevant documentation can be found in the docs folder and is hosted on GitHub Pages. Access the documentation on

The documentation for a specific branch can be accessed via https://pulp-platform.github.io/chimera-sdk/branch/<branch>

Formatting and Linting

We provide the pre-commit configuration file which you can use to install github hooks that execute the formatting commands on your changes.

We recommend that you setup a virtual environment and install the required dependencies using the following commands:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -r requirements-docs.txt

The configuration sets the default stage for all the hooks to pre-push so to install the git hooks run:

pre-commit install --hook-type pre-push

The hooks will run before each push, making sure the pushed code can pass linting checks and not fail the CI on linting.

If you change your mind and don't want the git hooks:

pre-commit uninstall

You can also run the hooks manually on all files using:

pre-commit run --all-files
# Or use the Makefile target
make format

The Makefile is only used for utility purposes and not by the build system.!

License

All licenses used in this repository are listed under the LICENSES folder. Unless specified otherwise in the respective file headers, all code checked into this repository is made available under a permissive license.

To extract license information for all files, you can use the reuse tool and by running reuse spdx in the root directory of this repository.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors