jwalsh / jwalsh/2048-cli-debug

Set up experimental framework with standardized nomenclature and layout

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Overview
Establish a consistent structure for the 2048 debugging experiments to improve portability, organization, and validation.

## Requirements
1. **Directory Structure**
- Each experiment should have its own subdirectory
- All generated files (scripts, data, images) should go in the experiment's directory
- Use relative paths instead of absolute paths

2. **Path Management**
- Set up with variable
- Use relative paths like instead of hardcoded paths
- Ensure scripts check their current directory and adjust output paths

3. **Org-mode Standards**
- Use proper org-mode syntax: for literals, for emphasis
- Ensure all tangle blocks use prefix for output paths
- Validate with org-lint

4. **Current Status**
- [x] Created exp_007/ through exp_011/ directories
- [x] Updated tangle paths to use exp_NNN/ prefix
- [x] Fixed most hardcoded paths to relative paths
- [ ] Create .envrc with PROJECT_ROOT
- [ ] Run org-lint validation
- [ ] Update remaining scripts to check current directory

## Experiments to Update
- exp_007_memory_layout_proof.org
- exp_008_statistical_validation.org
- exp_009_speed_baseline.org
- exp_010_timing_validation.org
- exp_011_timing_curve_analysis.org
- EXPERIMENT_TEMPLATE.org

## Benefits
- Experiments can be run from any location
- Better organization of generated artifacts
- Easier to share and reproduce experiments
- Cleaner git status with proper directory structure

Contributor guide

Open the contributing guide

Research direction

Start with EXPERIMENT_TEMPLATE.org and the listed exp_007 through exp_011 Org files to compare directory, tangle, and path conventions. Create the .envrc with PROJECT_ROOT, run org-lint on the Org files, and inspect remaining scripts for current-directory handling. Done means the checklist is complete and experiments use the stated relative layout.

Written by the indexing model from the issue text.

Assessment

Tech stack
emacs, python
Domain
documentation, tooling
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.