- Kunal Pai
- Parth Shah
- Harshil Patel
- Arslan Ali
gem5 is a simulation software used by computer architects both in academia and the industry. Being a simulator, it also provides certain Resources relevant to computer architecture, like Kernels, Bootloaders, Benchmarks, and Disk Images to its users. Currently, the Resources are stored in a Google Cloud Bucket. The only way a user of gem5 can access information regarding which Resources exist is by going through the resources.json file available here manually, which can be cumbersome. Our main goal is to make finding Resources easier for gem5 users and integrating it with other components of the gem5 ecosystem. Part of this goal involves categorizing the available Resources and making these Categories and Groups filtrable, and creating compatibility links between existent Resources. It also involves linking a Resource with example code from the gem5 source code, and also linking it with README files present in the gem5_resources repository. Another aspect of this project is to use a server to track analytics of various Resources.
But, on top of that, to make the user experience better, additional goals include adding a beginners’ section for first-time users of gem5 and adding more information within the frontend rendering and the backend data of a particular Resource page. This information is meant to help users and includes input size, expected output, logging for particular benchmarks within the suite that do not work, dependencies, version compatibilities (with different versions of gem5), download sizes, direct download links for the Resource, and if the Resource is tested or not.
To make the administration of Resources better, additional goals involve integrating MongoDB into the current Python wrapper that downloads Resources.
- Frontend: React (w/ NextJS as the framework)
- Database: MongoDB + JSON
- Backend: Analytics Server
- API Wrapper: Python
- Website Hosting: GitHub Pages
- Code: GitHub Organization
- Project Management: Notion + Google Drive
graph TD;
A[dev] --> B[JSON];
C[v22.1] --> B[JSON];
D[v22.0] --> B[JSON];
E[v21.2] --> B[JSON];
F[gem5/gem5_resources] --> I[gem5 Vision]
G[gem5/configs/gem5_library] --> I[gem5 Vision]
B[JSON] --> H[MongoDB]
B[JSON] --> I[gem5 Vision]
H[MongoDB] --> I[gem5 Vision]
J[Server to Track Stats] --> I[gem5 Vision]
K[gem5 prebuilt boards] -.-> I[gem5 Vision]
I[gem5 Vision] --> L[gem5 Resources Website]
I[gem5 Vision] --> M[Documentation]
I[gem5 Vision] --> N[Python Wrapper]
L[gem5 Resources Website] --> M[Documentation]
This is still a work-in-progress, but you can find the following documentation:
