datasci/ds-voidlinux-popcorn
1
0
Fork 0
Code Issues Pull requests Activity

Add code README and automatic CHANGELOG entries

Browse source
This commit is contained in:
Marty Oehme 2025-09-30 21:39:22 +02:00
parent fbba2d2992
commit 42e706080a
Signed by: Marty
GPG key ID: 4E535BC19C61886E
4 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

15
code/README.md
View file

@ -1,3 +1,12 @@
All custom code goes into this directory. All scripts should be written such
that they can be executed from the root of the dataset, and are only using
relative paths for portability.
# Popcorn dataset code
Each script can be run stand-alone like `python code/files.py <input-dir> <output-dir>`,
exchanging the script file for the one intended.
It is suggested, however, to run the scripts using the `just` command runner from the
dataset root, such as `just files` for the same effect as above.
This will automatically populate the correct input and output directories.
To create new `datalad` versioned output data, run `just versioned` or `just` without any arguments.
A new commit containing the updated data will be created,
and an automatic entry in the CHANGELOG made.