Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1.54 KB

README.md

File metadata and controls

35 lines (20 loc) · 1.54 KB
Raw

MaMpf statistics

A few python scripts to generate some statistics about the MaMpf project given an uncompressed database dump.

Pre-requisites

  • Python 3.8 or higher (tested with Python 3.11.5)
  • Install the required python packages via pip3 install -r requirements.txt.
  • Place a database dump in the data folder and name it mampf.sql.
    (This path can be modified in the .env file if necessary.)

Usage

Run one of the following scripts to extract the desired statistics. They are stored as PDF files in the out folder.

python3 src/last_sign_in.py
python3 src/email_hosts.py
python3 src/comments_dates.py

Troubleshooting

We use matplotlib to generate the plots and SciencePlots to make them look nice. This uses an underlying LaTeX backend to render the text in the plots. If you're experiencing the error LaTeX Error: File 'type1cm.sty' not found. you may be missing the type1cm package that does not ship with the base texlive install on Ubuntu and Gentoo as denoted here. Use the following command to install it:

sudo apt install texlive-fonts-recommended cm-super

Development

  • If you're using VSCode, go the the extensions tab and install the recommended extensions for this project (click on the filter icon and choose Recommended). This is mainly to ensure that the code is formatted correctly and that the linter (pylint) is working.