Browse Source

Update 'README.md'

Sebastian B. Mohr 1 year ago
parent
commit
403a7b9f6d
1 changed files with 15 additions and 2 deletions
  1. 15 2
      README.md

+ 15 - 2
README.md

@@ -1,8 +1,21 @@
 # covid19_soccer_data
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
-This is the datarepo for our publication "Using gender disparities to identify EURO2020 contributions to the COVID-19 spread"!
+This is the data repository for our publication "Using gender disparities to identify EURO2020 contributions to the COVID-19 spread"!
 
-Here you can download the traces from our analysis, these contain the posterior samples. For more information on how to use the traces, see https://github.com/Priesemann-Group/covid19_soccer.
 
+Here you can download the traces from our analysis, these contain the posterior samples. For more information on how these are created see https://github.com/Priesemann-Group/covid19_soccer.
 
+## How to use the traces
+
+To load a trace please install the requirements from our code [repository](https://github.com/Priesemann-Group/covid19_soccer/blob/main/requirements.txt). We recommend to create an conda environment such that you don`t have version mismatches.
+
+After installing the requirements you should be able to load a trace as follows:
+
+```python
+import pickle
+
+with open("trace.pkl", "wb") as f:
+        pickle.dump((model, trace), f)
+
+```