Skip to content

calkit/example-basic

Repository files navigation

Basic Calkit example

This is a basic Calkit example project, which includes data collection, figure generation, and LaTeX article compilation, all part of a single reproducible DVC pipeline.

You can also view this project on calkit.io.

This project can be reproduced with:

calkit run

Steps to recreate

  1. Create a new project on calkit.io.
  2. calkit new question "Can we make reproducibility simple?".
  3. Create a Conda environment with calkit new conda-env -n calkit-example-basic python matplotlib numpy pandas.
  4. Create the data collection stage with:
    dvc stage add -n collect-data \
        -o data/raw/data.csv -d \
        scripts/collect-data.py \
        "calkit runenv -n calkit-example-basic -- python scripts/collect-data.py"
  5. calkit run && git add . && calkit save -am "Run pipeline"
  6. Add a script and DVC stage to create a figure, similar to the two steps above.
  7. Add the figure and dataset to calkit.yaml by editing the figures and datasets section manually.
  8. Create a new LaTeX publication and Docker environment using the latex/article template. See the docs.