readme

# README

# ---------------------------------------------------------------
# mapska: Murder Accountability Project's Serial Killer Algorithm
# ---------------------------------------------------------------

# A much improved Linux/Perl implementation
# of MAP's Serial KIller Algorithm

# ------------
# Version: 2
# ------------

# Mapska.pm - Serial Killer Algorithm

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see http://www.gnu.org/licenses.#

# -------------
# Requirements:
# -------------

# Linux or Cygwin
# Bash 5+ (but any version should be fine)
# Perl 5
# Apache2 (or remote server access)
# Mariadb (or similar mysql)

# -------------
# Dependencies:
# -------------

# mapska depends on the following Perl modules

# Text::CSV_PP
# DBI

# --------------------
# Top-level functions:
# --------------------

prepare_SHR($SHR);
prepare_SHR_db($SHR,$DB,$HOST,$USER,$PW);
@DATA = all_clusters($MGRP,$SEX,$PCS,$SY,$EY,$DB,$HOST,$USER,$PW);
$result = get_cluster_sum($cluster,$MGRP,$SY,$EY,$DB,$HOST,$USER,$PW);
@DATA = get_cluster($cluster,$MGRP,$SY,$EY,$DB,$HOST,$USER,$PW);
@DATA = get_cluster_raw($cluster,$MGRP,$SY,$EY,$DB,$HOST,$USER,$PW);