Welcome to the Processor CI Connector.
The Processor CI Connector is a tool for processor connection and integration. Given a RISC-V processor, it can pre-process its source code, extract its instance, and establish a connection with the Processor CI Wrapper, automating part of the continuous integration flow.
For proper operation of the Processor CI Connector, the following dependencies are required:
- Verilator
- Python 3.8 or newer
- Pip
- Python Venv
- Ollama API
To install the project dependencies, run:
pip install -r requirements.txtThe Processor CI Connector is a command-line tool with an integrated parser. All available options can be displayed with the following command:
python main.py --helpA standard execution is performed using:
python main.py -p <Processor Name> -P <Path to processor repository> -m <LLM Model>If a local Ollama server is not available, you can configure the remote server address by exporting the SERVER_URL environment variable:
export SERVER_URL="<your server url and port>"The Processor CI Connector requires a valid Processor CI JSON configuration file to operate correctly. By default, the connector searches for this file in the directory:
/eda/processor_ci/config
This path can be modified using the -c flag:
python main.py -c <Path to config folder>The official documentation is available at: https://processorci.lsc.ic.unicamp.br
Questions, suggestions, and issue reports can be submitted in the Issues section of the GitHub repository. Contributions are welcome, and all Pull Requests will be reviewed and merged whenever possible.
To contribute improvements or fixes, please refer to the contribution guidelines available in: CONTRIBUTING.md
This project is licensed under the MIT License, granting full freedom for use, modification, and distribution.