Installation

1. Install through pip

   pip3 install redrum

2. (optional) Install service for automatic wallpaper changing

   # copy service files
   cp -u systemd/* ~/.config/systemd/user/
   
   # enable and start systemd timer
   systemctl --user enable redrum.timer
   systemctl --user start redrum.timer
   
   # the service can be triggered manually as well
   systemctl --user start redrum

   note: If using a python3 virtualenv, change ExecStart in redrum.service to /path/to/venv/bin/redrum

Usage

Redrum creates a config at ~/.config/redrum.ini automatically. You should update this file with your screen resolution and preferred subreddits before executing.

>>> redrum
No previous score cache found at /home/evan/.cache/redrum_cache.json.
Indexing page #0 from subreddit winterporn
Indexing page #1 from subreddit winterporn
Indexing page #2 from subreddit winterporn
...
Selected http://i.imgur.com/3UWbcYG.jpg (EarthPorn) with score 5.21729920261845e-05 out of 5971 images
The probability of selecting this image was 0.009851421028579594
Applying wallpaper

Scoring algorithm

Images are scored in three steps as follows:

1. Three input scores are calculated for each image in the cache

   \begin{equation*} pixel_score = [total image pixels] / [total screen pixels] \end{equation*}
   \begin{equation*} ratio_score = [image x-y ratio] / [screen x-y ratio] or [screen x-y ratio] / [image x-y ratio] (whichever is less than 1) \end{equation*}
   \begin{equation*} views_score = [# views of this image] / [highest # views of all images] \end{equation*}

2. Each input score is run through a sigmoid function, in this case, the logistic function. This helps to provide stronger differentiation between a good and a bad image than could be afforded with a linear method. The logistic function is defined by its midpoint and the slope at the midpoint, k.

   

   

   \begin{equation*} ratio_logistic_score = (1 + pow(math.e, -ratio_k * (1 - ratio_off)))/(1 + pow(math.e, -ratio_k * (ratio_score - ratio_cutoff))) views_logistic_score = (1 + pow(math.e, -ratio_k * (1 - ratio_off)))/(1 + pow(math.e, -views_k * (views_score - views_cutoff))) pixel_logistic_score = (1 + pow(math.e, -ratio_k * (1 - ratio_off)))/(1 + pow(math.e, -pixel_k * (pixel_score - pixel_cutoff))) \end{equation*}

   pixel_score, ratio_score, and views_score each have their own midpoint and k, which can be set in ~/.config/redrum.ini

3. The three logistic scores are then multiplied to calculate an image’s final_score. This score is used to do a random weighted select of all images in the cache. An image with a final_score that is twice the score of another image is twice as likely to be selected during the random selection.

Tuning the scoring algorithm

You can adjust the scoring algorithm if you aren’t satisfied with the images being selected. redrum_tune allows you to quickly adjust the midpoint and k of the logarithmic function and view its effects on the final_score. You need to run pip install redrum[tune] to install the extra dependencies (matplotlib, numpy).