#==============================================================================================
# The Jabalín morphological generator for Arabic verbs
#
# Copyright (c) 2012 Susana López Hervás, Alicia González Martínez, Antonio Moreno Sandoval
# 
# 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/>
#==============================================================================================



================================
 THE JABALÍN VERBAL GENERATOR 
================================

DESCRIPTION

The Jabalín verbal generator generates the full conjugation of a given lexicon of verb lemmas. The program is written in python 3.

The system includes a complete lexicon of Modern Standard Arabic and Classical Arabic verb lemmas 
named "lexicon_lemas_jabalin.txt" as the default input lexicon for the system. 

If you want to generate the conjugation of a different input lexicon please read the the file JabalínLinguisticDocumentation.pdf to know the required format of input file. In this file you will also find information on the tagset used in the output file generated by the system.

The jabalín generator includes the following files:

    JabalinGenerator.py
    ID.py
    PT.py
    ED.py
    vocalization.py
    stem_adjustment.py
    Inflec.py
    phonotactics.py
    utilities.py
    lexicon_lemas_jabalin.txt
    linguisticDocumentation.pdf


HOW TO RUN

1. Open the shell in the Jabalín directory and write the following in the command line, specifying the name of the output file:

    On windows:
        >>> C:/Python32/python.exe JabalinGenerator.py lexicon_lemas_jabalin.txt name_output_file.txt

		Note: check your exact version of python 3

    On Linux and Mac:
        >>> python3 JabalinGenerator.py lexicon_lemas_jabalin.txt name_output_file.txt


2. After some minutes your output file will contain the full conjugation of the verbs incuded in the input file.

    Note: To fully understand the information of each verbal entry please read the JabalínLinguisticDocumentation.pdf document.



=============================
 THE JABALÍN DATA EXTRACTOR 
=============================

DESCRIPTION

The file "DataExtractor.py" allows you to extract frequency data from the output lexicon of inflected forms.
When you run the program a menu appears to allow you to select the information you want to extract.

The jabalín data extractor includes the following files:

    DataExtractor.py
    util_DataExtractor.py
    lexicon_lemas_jabalin.txt

    Important note: the program also needs a text file named "lexiconVerbs_jabalin.txt"
                    This file is the output of the generation system.
                    Be sure to name the file as it is indicated.


HOW TO RUN

1. Open the shell in the Jabalín directory and write the following in the command line:

    On windows:
        >>> C:/Python32/python.exe DataExtractor.py
    On Linux and Mac:
        >>> python3 DataExtractor.py

2. Choose the option for the desired data

3. The results will be shown directly on the shell.


**********************************************************
* FOR ANY QUESTIONS PLEASE CONTACT: aliciagm85@gmail.com *
**********************************************************