https://github.com/daniqss/codee-graph-generator
Generate graphs from Codee analysis. Project from hackUDC 2024
https://github.com/daniqss/codee-graph-generator
codee hackathon matplotlib python
Last synced: 2 months ago
JSON representation
Generate graphs from Codee analysis. Project from hackUDC 2024
- Host: GitHub
- URL: https://github.com/daniqss/codee-graph-generator
- Owner: daniqss
- License: mit
- Created: 2024-02-16T20:00:55.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-18T09:56:57.000Z (over 1 year ago)
- Last Synced: 2025-03-17T11:30:04.751Z (3 months ago)
- Topics: codee, hackathon, matplotlib, python
- Language: Jupyter Notebook
- Homepage:
- Size: 2.43 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Description
codee_graph_generator is a Python program that generates a graph from the output of the Codee tool. The graphs are generated using the Matplotlib library and are saved as HTML files using the mpld3 library.
[Codee](https://www.codee.com/) is a suite of command-line tools aimed at helping software developers to build better quality parallel software in less time.
# Script usage
The run.py program is used to execute Codee on a list of given files.
The CODEE_PATH env variable has to be the executable path
Here is a description of its usage:
```bash
CODEE_PATH=/path/to/codee python run.py ... /
```
# Run Docker containers
To run the codee_graph_generator, you need to have Docker installed on your machine. The following command will build the Docker image and run the codee_graph_generator on the given files.
### In Linux
```bash
cd buildbot
chmod +x build_containers.sh
bash ./build_containers.sh
GIT_URL=https://github.com/githubuser/repo.git CODE_PATH=/path/to/codee docker compose up
```
### In Windows
```cmd
cd buildbot
set GIT_URL=https://github.com/githubuser/repo.git
buildbot\build_containers.bat
```
To visualize the results, open localhost:9000 in your browser.
# Contributing
If you want to contribute to the project, please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
# License
This project is licensed under the terms of the [MIT License](LICENSE.md).