source: sicp/README.md @ d207f1a

Documentación
===


## Simulador Integral de Cadenas Productivas

       _____ ______________
      / ___//  _/ ____/ __ \
      \__ \ / // /   / /_/ /
     ___/ // // /___/ ____/
    /____/___/\____/_/




El __Simulador Integral de Cadenas Productivas (SICP)__ le permite modelar y simular las cadenas productivas desde
distintas fuentes de datos como son: El [Sistema de Gestión para la Industria y Comercio (SIGESIC)]
(https://sigesic.mppi.gob.ve/), La [Encuesta Industrial]
(http://www.ine.gob.ve/index.php?option=com_content&id=347&Itemid=36&view=article) y la [Matriz Insumo / Producto]
(http://www.bcv.org.ve/cuadros/series/mip97/mip97.asp?id=425), con el objetivo de suministrar
información sistematizada acerca de la estructura industrial del pais y las características (flujo de entrada y salida
de bienes) de un sector productivo y/o empresa en particular.

## Licencia

__SICP__, sus carpetas y archivos, se disribuye bajo la Licencia de Software Libre GNU/GPL versión 2, esto implica que
el usuario final de la aplicación esta en la libertad de ejecutarla, modificar su código fuente, copiarla y/o
distribuírla, siempre y cuando al hacerlo se citen las fuentes originales de ésta aplicación.

Para obtener mayor información en torno a los términos de la licencia bajo los cuales se distribuye la
aplicación, lea con atención la [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html).

Así mismo, las librerías y apis de terceros implementadas en esta aplicación, se distribuyen con sus respectivas
licencias y acuerdos particulares de cada una especificadas en los archivos de esas librerías.

## Pre-requisitos

Para el correcto funcionamiento del __SICP__ se requiere tener instalado previamente los siguientes paquetes:

    // Paquetes del Sistema Operativo
    PostgreSQL 9.x
    Python >= 2.7 < 3.0
    PIP >= 1.5.4
    librsvg2-bin >= 2.40.2
    libxml++
    
    // Paquetes de Python
    Django >= 1.8 < 1.9
    django-suit == 0.2.13
    Pillow >= 2.8.1
    django-simple-captcha >= 0.4.5
    psycopg2 >= 2.6
    reportlab >= 3.2.0
    
## Proceso de instalación

En el proceso de instalación sobre los requerimientos y herramientas necesarias para el correcto funcionamiento del 
sistema, se deben ejecutar algunas instrucciones desde la consola de comando para lo cual se requiere abrir una terminal 
y ejecutar los siguientes comandos:

    // Para distribuciones ubuntu
    ~$ sudo su -
    
    // Para distribuciones debian
    ~$ su -
    
Lo anterior solicitara la contraseña de administrador del sistema operativo para acceder al usuario root, esto es 
necesario para los procesos de instalación posteriores de la aplicación.

Una vez autenticados como usuario root del sistema operativo, mostrará en la consola el símbolo "#" que identifica que 
el usuario actual es root, esto permitirá instalar en el sistema operativo los requerimientos de funcionamiento del 
sistema para lo cual se ejecutarán los comandos detallados a continuación:

    // Instalación de paquetes del sistema operativo
    ~# apt-get install postgresql python2.7 python-pip
    
    // Instalación de paquetes de python (se debe acceder a la ruta principal del proyecto sicp)
    ~# pip install -r requerimientos/comun.txt
    
Esto ejecutara los distintos procesos de instalación sobre los requerimientos del sistema.

Posteriormente se debe crear la base de datos del __SICP__ y el correspondiente usuario que tendrá los privilegios 
necesarios para interactuar con la misa, esto se hace de la siguiente forma:

    // Acceso al usuario postgres
    ~# su postgres
    
    // Acceso a la interfaz de comandos de postgresql
    postgres@xxx:$ psql template1 
    
    // Creación del usuario de a base de datos
    temlate1=# CREATE USER nombre_usuario_bd WITH ENCRYPTED PASSWORD 'contraseña' createdb;
    temlate1=# \q
    
    // Desautenticar el usuario postgres y regresar al usuario root
    postgres@xxx:$ exit
    
    // Creación de la base de datos
    ~# createdb nombre_bd -E 'UTF-8' -O nombre_usuario_bd -h localhost -p 5432 -U nombre_usuario_bd
    
    // Salir del usuario root
    ~# exit
    

## Configuración y ejecución de la aplicación

Una vez instalados todos los requerimientos previos del sistema, se procede a la configuración del mismo, para esto se 
debe editar el archivo settings.py dentro de la carpeta sicp y modificar los datos por defecto de la variable DATABASES, 
en donde se especificarán los datos de acceso a las bases de datos de la aplicación y del sigesic.

Al tener ya configurado los parámetros de acceso a la base de datos, se ejecutan los siguiente comandos:

    // Para construir las migraciones de la base de datos en caso de que no existan

    ~$ python manage.py makemigrations

    // Para crear la estructura de la base de datos

    ~$ python manage.py migrate

Lo anterior crea la estructura de la base de datos e incorpora los registros básicos de la aplicación.

Para ejecutar la aplicación en modo de desarrollo, se debe ejecutar el siguiente comando:

    ~$ python manage.py runserver
    
Lo anterior ejecutará el servidor de desarrollo de django bajo la URL [http://localhost:8000](http://localhost:8000), 
para lo cual deberemos acceder a un navegador web y escribir dicha dirección URL.


## Documentación

Para acceder a la documentación del sistema, en donde se especifican las clases, funciones, atributos y métodos 
utilizados en la aplicación, debe abrir el archivo index.html ubicado en static/docs/sistema