Hackathon Deliverables Guide
To successfully complete the hackathon, your team must submit the following deliverables. These showcase your project, from code to presentation, and demonstrate your efforts in evaluating the reproducibility of scientific papers. All deliverables should be organized, professional, and easy to access.
1. GitHub Repository
Create a public GitHub repository to host your project’s materials. Include the following items:
- README.md File
- A clear description of your project, including its goals and how it addresses reproducible science.
- Example: Explain how your team evaluated HPC papers and what you learned.
- Source Code
- All code used in your project (e.g., scripts to run experiments or analyze papers).
- Include comments in the code to explain what each part does.
- Example: Python scripts for testing a paper’s code or automating scorecard calculations.
- Project Poster (PDF)
- A PDF version of your poster summarizing your project.
- Should be visually appealing and include key findings (e.g., scorecard results).
- Final Presentation (PDF)
- A PDF of your presentation slides, covering:
- Team Members: Names and photos of all team members.
- Technology Used: Tools, software, or HPC resources (e.g., Docker, Slurm, GPUs).
- Scoring of Papers:
- Results from evaluating 2023 ISCE (International Symposium on Cluster, Cloud and Internet Computing) example papers.
- Results from evaluating 2024 Supercomputing (SC) conference papers.
- Scorecard Explanation: Describe how your scorecard works, including:
- Paper Availability: Can the paper be accessed (e.g., open-access or behind a paywall)?
- Availability of Code and Software: Is the code shared (e.g., on GitHub) with instructions?
- Availability of Datasets: Are datasets accessible, and is metadata provided?
- Computer Requirements: What hardware is needed (e.g., CPU, memory)?
- GPU Requirements: Are GPUs required, and what specs?
- Three Additional Metrics: At least three other criteria your team used (e.g., documentation quality, reproducibility of results, ease of setup).
- Ensure slides are clear and engaging.
- A PDF of your presentation slides, covering:
2. Website or Portal
Create a simple website or portal (e.g., hosted on GitHub Pages or another platform) to showcase your project. It should include:
- Scorecard Results
- Display the scores for the 2023 ISCE and 2024 Supercomputing papers.
- Example: A table or chart showing how each paper scored on your reproducibility metrics.
- Explanation of Scorecard Metrics
- Clearly describe each metric (e.g., code availability, dataset access) and why it matters for reproducibility.
- Example: “We checked if datasets were on public repositories like Zenodo to ensure anyone could use them.”
- Team Member Profiles
- List all team members with:
- Names
- Photos
- GitHub profiles (links)
- LinkedIn profiles (links)
- Example: A section with a brief bio and picture for each teammate.
- List all team members with:
3. Proof of Poster Submission
- Submit your project poster to the Gateways 2025 conference.
- Provide proof of submission (e.g., a screenshot of the confirmation email or submission ID).
- Bonus: Including this proof adds +5 points to your judging score!
Tips for Success
- Organize Your Repository: Use clear folder names (e.g.,
code/
,poster/
,presentation/
) and a detailed README to guide judges. - Test Your Website: Ensure links work and the site is accessible on any browser.
- Be Clear and Concise: Make your scorecard metrics easy to understand, with examples from the papers you evaluated.
- Collaborate as a Team: Divide tasks (e.g., one person handles the website, another the poster) to meet deadlines.
- Ask for Help: If you’re stuck (e.g., setting up a GitHub repository or hosting a website), reach out to the hackathon organizers—we’re here to support you!
This reformatted list organizes the deliverables into clear categories, simplifies the language, and provides examples to make expectations accessible. It aligns with the hackathon’s focus on reproducible science in HPC and ensures participants can present their work effectively. If you need further tweaks (e.g., templates for the README or website), let me know!