Adds requirements.txt file.

Updates README file to account for installation instructions.
nunesgh · May 21, 2024 · ef8bcff · ef8bcff
1 parent b51c42c
commit ef8bcff
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -26,6 +26,16 @@ Please note that [`qif`](https://github.com/chatziko/libqif), as of version 1.2.
 
 The datasets produced for the experimental analyses can be found on Zenodo: *AOL Dataset for Browsing History and Topics of Interest* (DOI: [10.5281/zenodo.11029572](https://doi.org/10.5281/zenodo.11029572)).
 
+### Installation
+
+For convenience, create a Python virtual environment before installing the required packages:
+
+```
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
+```
+
 ## Data treatment
 
 The data treatment notebooks are primarily for reference and were used to generate the *AOL Dataset for Browsing History and Topics of Interest* (DOI: [10.5281/zenodo.11029572](https://doi.org/10.5281/zenodo.11029572)) files.

diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,10 @@
+bvmlib==1.0.0
+matplotlib==3.8.0
+numpy==1.24.3
+pandas==2.0.1
+qif==1.2.3
+requests==2.31.0
+scipy==1.11.3
+tldextract==5.1.2
+tqdm==4.66.1
+urllib3==1.26.16