AEA Data Editor

AEA Data Editor

The AEA Data Editor’s mission is to design and oversee the AEA journals’ strategy for archiving and curating research data and promoting reproducible research.

Finalize README

Published:

◀ Back to Checklist Back to Details ◀ Previous: Step 5 Next: Submitting ▶

Finalize README

Reference: https://social-science-data-editors.github.io/template_README/template-README.html

This step is usually not necessary, but you want to just make sure that your README has the necessary information that help set expectations about computational feasibility, based on the steps above.

  • Software: If you used a container, specify which container you used (name and tag, e.g., dataeditors/stata18_5-mp:2025-02-26). Be precise when describing the StataMP version - the number of cores matters! (StataMP-4 may not behave the same way as StataMP-8.)
  • Hardware: Verify that the description of your computer (CPU, number of cores, RAM, disk space) is accurate.
  • Run time: Provide an estimate of the expected run time, however trivial it might be. It matters to the replicator!

Examples:

- OS: "openSUSE Leap 15.6"
- Processor:  13th Gen Intel(R) Core(TM) i7-1365U, 12 cores
- Memory available: 30GB memory
- Docker version 28.4.0-ce, build 249d679a6 
- stata version 18-mp-i (Docker image dataeditors/stata18-mp-i:2024-12-18) (born date: "18 Dec 2024") with 32 core license

Code ran for about 35 hours.

- OS: Windows Server AMD EPYC 7763 64-Core Processor 2.44 GHz, 128GB
- Stata/MP4 19.5 ("21 May 2025")
- MATLAB R2025a

Code runs about 10 minutes for Stata portion, and about 5 days for MATLAB portion.

NOTE about SIVACOR here: You should not modify your README after your last run on SIVACOR, as the TRO generated by SIVACOR contains a checksum that would highlight the modification to the README. However, the auxiliary files generated by SIVACOR (the .jsonld file) contain all the necessary information.

▶ Next: Submitting

Published: