Improve "Code and sample data" section
https://py.geocompx.org/preface#code-and-sample-data
- It only lists .ipynb and \data files. Many chapters also rely on the \output files (created in Chapter 1), however, I assume that some reader will only try to run some chapters. Maybe we could make copies of some files from \output to \data? Or you have some better idea?
- "landsat.tif" is not in the \data folder of the repo (maybe some others are also missing)
- Do we even use some of the files listed (e.g., yorkshire.json)?
- Can you explain me how the ipynb files are created? Maybe I could modify our GitHub action to make them automatically...
- You're right, thanks! Now corrected in the text (https://github.com/geocompx/geocompy/commit/d0eb98107dde873b2b385132bbcbe8d67ca1d205)
landsat.tifwas in.gitignore, I now removed the entry from there. I checked and no other files are missing
- Right, thanks! Now removed
yorkshire.json, there are no other unnecessary files as far as I checked
- The
.ipynbfiles are created using:
for i in *.qmd; do
quarto convert $i
done
(https://github.com/geocompx/geocompy/blob/main/convert.sh) It's a good idea if this can be automatic, thanks
@michaeldorman -- see https://github.com/geocompx/geocompy/tree/geocompy.
I think I was able to create a GitHub action that creates ipynb files and move them (and data folder) to a new branch. See https://github.com/geocompx/geocompy/blob/main/.github/workflows/prep-book-package.yml.
This GitHub action only starts when your commit message contains "update book package"
The above approach allows us to create GitHub releases (from the geocompy branch): see https://github.com/geocompx/geocompy/releases/tag/0.2.
@michaeldorman would you be able to update the data/code instructions in the book?
Hi @Nowosad ,looks great, thanks! Perhaps the release can also contain the output directory? (according to note (1) in the first comment in this thread)
See it now: https://github.com/geocompx/geocompy/tree/geocompy
Let me know if there is something still missing. If not -- feel free to create a new release.
As far as I can tell this is solved, so closing, thanks @Nowosad 🙏