# Promoting Open Science in Educational Data Mining: An Interactive Tutorial on Licensing, Data, and Containers [![OSF][badge]][osf] *Promoting Open Science in Educational Data Mining: An Interactive Tutorial on Licensing, Data, and Containers* is a tutorial to be presented at the [*17th International Conference on Educational Data Mining*][edm]. This project serves as the repository holding the webpage. The rendered version can be viewed at https://edm2024-tutorial.howtoopenscience.com. ## License The content of this Open Science Foundation project under the [Creative Commons Attribute 4.0 International License][cc4]. ## Local Setup ### [Docker][docker] Container Clone this repository and run the following commands: ``` docker build -t <image_name> . docker run --rm -it -p 8000:8000 -v ${PWD}/src:/docs <image_name> ``` `image_name` can be specified to whatever identifier the user desires. This will run the docs server and expose it to the local host on port 8000. ### Python This setup runs in Python 3.9.5. You can install the required libraries through the provided `requirements.txt`: ``` pip install -r requirements.txt ``` Then navigate to the `src` folder in your terminal and serve the docs. ``` cd ./src mkdocs serve ``` > You may need to prefix the `pip` or `mkdocs` command with either `python3 -m` for Unix systems or `py -m` for Windows systems if the python modules were not properly installed onto the path. [badge]: https://img.shields.io/badge/OSF-10.17605%2Fosf.io%2Fthsgx-blue [osf]: https://doi.org/10.17605/osf.io/thsgx [edm]: https://educationaldatamining.org/edm2024/ [cc4]: https://creativecommons.org/licenses/by/4.0/ [docker]: https://www.docker.com/