Skip to content

tsmdt/labcal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LABcal: Automated Calendar Analysis

License: CC BY 4.0 Binder DOI

LABcal is a streamlit web app that parses iCalendar files (.ics) and returns various statistical plots that are based on a dict like structure in the calendar field DESCRIPTION.

The app was created as a final project for the Data Librarian certificate course organised by TH Köln in 2023/24. It serves to simplify the generation of user statistics for the Education Lab ExpLAB at the University Library Mannheim.

Usage

Start LABcal by either running the streamlit app from the terminal (see installation instructions below) or by running the jupyter notebook code demo through binder:

Binder

Repository layout

project_dir /
├── assets /
├── data /
│   └── dummy_cal.ics        # Calendar with anonymised data
├── labcal /                 # LABcal python package
│   ├── __init__.py
│   ├── plot_cal.py          # Plotting functions
│   └── process_cal.py       # Data processing functions
├── app.py                   # LABcal streamlit app
├── labCal_notebook.ipynb    # Code demo (jupyter notebook)
├── LICENSE
├── README.md
└── requirements.txt

Requirements

Python >= 3.10

Installation

1. Clone this repository

git clone https://github.com/tsmdt/labcal.git

2. Change to project folder

cd labcal

3. Create a Python virtual environment

python3 -m venv venv

4. Activate the Python virtual environment

source venv/bin/activate

5. Install dependencies

pip install -r requirements.txt

6. Run the Jupyter notebook

jupyter notebook labCal_notebook.ipynb

7. Or start the Streamlit app

streamlit run app.py

Paper

Find the corresponding paper on MADOC.

@report{madoc67961,
  language = {English},
  title = {LABcal: Automated calendar analysis for the Education Lab "ExpLAB" at the University Library Mannheim : final project in the Data Librarian Certificate Course 2023/24},
  address = {Mannheim},
  year = {2024},
  author = {Thomas Schmidt},
  url = {https://madoc.bib.uni-mannheim.de/67961/}
}

Links

License

Licensed under CC BY 4.0.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published