Logbook for Open Reaction Database analyses, research reports, and notes.
This repo collects investigative work: data analyses, research write-ups, experiment
notes, and anything else worth keeping but not belonging in a code repo. Entries are
living documents — revise and expand them as understanding improves. Keep each entry's
Status and Date header current so readers know how settled it is, and lean on git
history when you need to see how a conclusion evolved.
entries/YYYY-MM-DD-slug/
README.md the entry itself
assets/ figures, data extracts, and scripts the entry references
README.md what each of those files is, when there are enough to need a guide
TEMPLATE.md copy this to start a new entry
On every push and pull request, CI lints Markdown, checks that relative links
resolve and that each entry's metadata block is filled in, verifies license headers
on source files, and rejects oversized files (see .github/workflows/ci.yml). The
same checks run locally via pre-commit — install once
with:
pre-commit installentry=entries/$(date +%Y-%m-%d)-short-slug
mkdir -p "$entry"
cp TEMPLATE.md "$entry/README.md"
# write it up, drop any figures and scripts in "$entry/assets"
git add "$entry"
git commit -m "Add entry: short description"
git pushEverything an entry references — figures, data extracts, the scripts that produced
them — lives in that entry's assets/, so a whole piece of work moves and reads as
one unit while the entry directory leads with the write-up rather than a wall of
files. Once there are enough supporting files that a reader would have to guess
what they are, add an assets/README.md saying what each one produces. For anything
large or binary-heavy, link out rather than committing it here.
Every Markdown file under entries/ opens with a metadata block. An entry states
its Date, Author, Status, Tags, and License; a supporting document — a
manifest, a design note, a plan — states Date, Author, and License, since
status and tags describe the investigation rather than the file. The stated date is
the entry's own, matching the directory name.
This repository carries two licenses, because it holds both writing and code:
| what | license | file |
|---|---|---|
| The entries themselves, and the figures and data extracts beside them | CC-BY-SA-4.0 | LICENSE |
The scripts under entries/, and the workflows and scripts under .github/ |
Apache-2.0 | LICENSE-CODE |
CC-BY-SA-4.0 matches ord-data, so a figure or table can move between the two repositories without a license change.
The code carries a separate license because Creative Commons licenses are not intended for software — Creative Commons recommends against it — and because the project's other code repositories, including ord-schema, are Apache-2.0. The analysis scripts here are meant to be reusable, so they get the license people expect to find on code.