This repository provides the source code to reproduce all figures and table in our publication with the above title that we intend to submit to The Green Journal and update them in case the data changes. Below we provide instructions on how to achieve this.
Warning
This paper is still under review and not yet published. Content and data here are still subject to change.
Important
All software in this repository is licensed under the MIT license. However, when executed, the pipeline described here will download data that is licensed under CC BY-SA 4.0.
First, clone the repository:
git clone https://github.com/rmnldwg/oral-cavity-paper
And change your working directory to the root of the repository:
cd oral-cavity-paper
Note
Requires bash on Linux
If you're using bash on Linux and don't want to install Docker, you may get away with simply running the repro.sh script:
bash setup.sh
It should do the following things in order:
- pull changes from the GitHub remote repo,
- automatically find your latest Python 3 installation,
- set up a virtual environment,
- install all Python packages defined in
requirements.txt, - download (and update) the data sources,
- reproduce the pipeline
But this script is probably quite platform dependent. So, if this does not work, a safer way to get the desired results is using Docker, which is explained below.
Note
Requires a Docker installation.
Although Docker is platform independent, it is sometimes a hassle to get it installed and running. Here is a guide to the Docker installation.
If Docker is up and running on your system, the following two commands should do the reproduction:
docker build -t ocp-image .
and then run it with the following command:
docker run \
--rm --volume .:/usr/src/oral-cavity-paper \
--name ocp-container \
ocp-image
That should run the pipeline from joining the datasets to plotting the figures and tables.