Testing texts and .md files updated

.gitignore

+pyfreeling.py
+_pyfreeling.so
+__pycache__/
+.ipynb_checkpoints/

INSTALL.md

-# INSTALLATION INSTRUCTIONS
+# Installation instructions
 
-## REQUIREMENTS
+## Requirements
 
-(Freeling version, Python, NumPy, etc.)
+- python3:
+  - pip3 install numpy
+  - pip3 install scipy
+  - pip3 install pandas
+  - pip3 install matplotlib
+  - pip3 install openpyxl
+- freeling 4.x:
+  - sudo apt install libboost-dev
+  - sudo apt install libboost-all-dev
+  - sudo apt install zlib1g
+  - sudo apt install zlib1g-dev
+  - sudo apt install swig
 
-## INSTALLATION PROCEDURE
+## Installation procedure
 
-1.
-2.
-3.
-...
+1. Install all the previous requirements. For freeling, follow the [installation manual](https://github.com/TALP-UPC/FreeLing-User-Manual).
+If you’re installing it from source, you’ll need to add -DPYTHON3_API=ON (or -DPYTHON2_API=ON) in the cmake command.
+2. Download or clone this repository.
+3. In %FLINSTALL%/share/freeling/APIs/pythonX, you’ll find the following files:
+- pyfreeling.py
+- _pyfreeling.so
+- sample.py
+You’ll need to copy both pyfreeling.py and _pyfreeling.so into your project folder.
 
-## TESTING
+## Testing
+
+In order to test the class with the [examples.ipynb](examples.ipynb) notebook, you first need to:
+- Install and run Jupyter Notebook.
+- Modify the FREELINGDIR variable in the [TextComplexityFreeling.py](TextComplexityFreeling.py) script, line 15 to be your FreeLing installation directory (/usr/local by default).
+- Run the [examples.ipynb](examples.ipynb) script in your notebook.
+This script analyzes every text under the folder ./texts/ and will generate 3 .xlsx files containing the results in your project's folder.
 
-(talk about the notebook to test it)

README.md

@@ -4,5 +4,10 @@ This class provides methods for the calculation of different complexity metrics
 
 # Files
 
-(put here a description of files)
+- [INSTALL.md](INSTALL.md): A guide to make this project work on your local environment.
+- [LICENSE.md](LICENSE.md): This project is licensed under the GNU General Public License v3.0.
+- [CREA_total.txt](CREA_total.txt): A dataset of 737799 spanish words ordered by its absolute frequency.
+- [TextComplexityFreeling.py](TextComplexityFreeling.py): This class provides methods for the calculation of different complexity metrics on text.
+- [examples.ipynb](examples.ipynb): Jupyter notebook that shows how to use the TextComplexityFreeling class in several testing texts.
+- [texts/](texts/): Folder that contains all the testing texts used by the examples notebook.
 

TextComplexityFreeling.py

 # -*- coding: utf-8 -*-
-import freeling
+ 
+#import freeling
+import pyfreeling as freeling    # Use this import instead of the one above if 
+                                 # you installed freeling following the user's manual
 import os
 import re 
 from functools import reduce

texts/text1.txt

+La última luna llena del año, que se observará completa este jueves en el cielo, será especial. Se produce estos días el fenómeno conocido como luna fría, una coincidencia astronómica que hace las delicias de quienes atribuyen al astro cualidades esotéricas. Sucede cuando la Tierra se encuentra ubicada exactamente entre el sol y la luna, de forma que la luna recibe directamente la luz.
+La luna llena será visible durante toda la noche, pero alcanzará su magnitud máxima cuando se encuentre a medio cielo, de forma que, al reflejar completamente la luz del sol que incide en la tierra, se verá especialmente grande y luminosa.
+Se llama luna fría porque marca la llegada del invierno en el hemisferio norte, aunque también se conoce como luna de las noches largas al ocurrir cerca del solsticio, informa National Geographic, que cita a un astrónomo de la NASA.
+La luna fría de 2019 coincide además con la lluvia de meteoros Gemínidas, visible entre el 7 y el 17 de diciembre pero que alcanzará su punto máximo de actividad entre el 11 y el 13. Es la lluvia de estrellas más masiva, lo que la hace mucho más brillante. El cielo augura todo un espectáculo esta noche.
+

texts/text2.txt

+Había una vez una liebre muy pero muy vanidosa; corría veloz como el viento, y estaba tan segura de ser el animal más rápido del bosque, que no paraba de presumir ante todo aquel que se encontraba en su camino. Pero sin duda quien más sufría la vanidad de la liebre era la pobre tortuga: cada vez que se encontraban por el bosque, la liebre se burlaba cruelmente de su lentitud.
+-¡Cuidado tortuga, no corras tanto que te harás daño! Le decía entre carcajadas.
+Pero llegó un día en que la tortuga, cansada de las constantes burlas de la liebre, tuvo una idea:
+-Liebre -le dijo- ¿corremos una carrera? Apuesto a que puedo ganarte.
+-¿Tú ganarme a mí?- le respondió la liebre asombrada y divertida.
+-Sí, como lo oyes. Vamos a hacer una apuesta y veremos quien gana- dijo la liebre.
+La liebre, presumida, aceptó la apuesta sin dudarlo. Estaba segura de que le ganaría sin ni siquiera esforzarse a esa tortuga lenta como un caracol.
+Llegó el día pactado, y todos los animales del bosque se reunieron para ver la carrera. El sabio búho fue el encargado de dar la señal de partida, y enseguida la liebre salió corriendo dejando muy atrás a la tortuga, envuelta en una nube de polvo. Pero sin importarle la enorme ventaja que la liebre le había sacado en pocos segundos, la tortuga se puso en marcha y pasito a pasito, a su ritmo, fue recorriendo el camino trazado.
+
+Mientras tanto la liebre, muy confiada en sí misma y tan presumida como siempre, pensó que con toda la ventaja que había sacado podía tranquilamente echarse a descansar un ratito. Se detuvo debajo de un árbol y se recostó a su sombra, y allí se quedó dormida. La tortuga, lentamente pero sin descanso, siguió caminando paso tras paso.
+No se sabe cuánto tiempo durmió la liebre, pero cuando se despertó, casi se queda muda de la sorpresa al ver que la tortuga la había pasado y se encontraba a pocos pasos de la meta. La liebre se levantó de un salto y salió corriendo lo más rápido que pudo, pero era tarde: ¡la tortuga ganó la carrera!.
+Ese día la liebre aprendió una importante lección: jamás hay que burlarse de los demás ni creer que somos mejores solo porque hacemos muy bien algo. Y también aprendió que la vanidad nos conduce a dar por seguros éxitos que todavía no hemos alcanzado.
+

texts/text3.txt

+La historia del PLN empieza desde 1950, aunque existe trabajo encontrado desde periodos anteriores. En 1950, Alan Turing publicó Computing machinery and intelligence el cual proponía lo que hoy llamamos test de turing como criterio de inteligencia. El experimento de Georgetown en 1954 involucró traducción automática de más de sesenta oraciones del Ruso al Inglés. Los autores sostuvieron que en tres o cinco años la traducción automática seria un problema resuelto. El progreso real en traducción automática fue más lento y después del reporte ALPAC en 1996, el cual demostró que la investigación había tenido un bajo desempeño. Más tarde investigación a menor escala en traducción automática se llevó a cabo hasta finales de 1980, cuando se desarrollaron los primeros sistemas de traducción automática estadística. Esto se debió tanto al aumento constante del poder de cómputo resultante de la Ley de Moore y la disminución gradual del predominio de las teorías lingüísticas de Noam Chomsky (por ejemplo, la Gramática Transformacional), cuyos fundamentos teóricos desalentaron el tipo de lingüística de corpus, que se basa el enfoque de aprendizaje de máquinas para el procesamiento del lenguaje. Algunos de los primeros algoritmos de aprendizaje automático utilizados, tales como árboles de decisión, sistemas producidos de sentencias si-entonces similares a las reglas escritas a mano. Se puede consultar un resumen de la historia de 50 años de procesamiento automático de publicaciones después del proyecto NLP4NLP en forma de una publicación doble en Frontiers in Research Metrics and Analytics.