Metadata-Version: 2.1
Name: tormetron
Version: 0.0.dev2
Summary: Download, save and process rainfall radar images from AEMET
Home-page: https://github.com/jlbmdm/tormetron
Author: Bengoa
Author-email: tratratron@gmail.com
License: MIT
Description: # Tormetron
        
        Tormetron es un paquete destinado a descargar, guardar y procesar imÃ¡genes ofrecidas por AEMET (www.aemet.es) referentes a:
          * Radares de precipitaciÃ³n. Fuente: API de AEMET ([aemet open data](https://opendata.aemet.es/)).
          * PrecipitaciÃ³n acumulada de 6 horas. Fuente: web de AEMET ([aemet radar](http://www.aemet.es/es/eltiempo/observacion/radar)).
          
        PÃ¡gina web ~~en preparaciÃ³n~~
        
        ## Descarga e instalaciÃ³n
        
        Se puede descargar e instalar en un solo paso desde [PyPI](https://pypi.org/project/tormetron/):
        
        * VersiÃ³n de prueba en test.pypi.org:
        
        ```
        $ pip install -i https://test.pypi.org/simple/ tormetron==0.0.1
        ```
        
        * Ãšltima versiÃ³n disponible en pypi:
        
        ```
        $ pip install tormetron
        ```
        
        Tormetron funciona en Python 2.7 y en Python 3.4 o superior.
        
        Se puede descargar la versiÃ³n en desarrollo disponible en [github](https://github.com/jlbmdm/tormetron) (repositorio provisionalmente privado; se harÃ¡ pÃºblico con la versiÃ³n 1.0.0)
        
        Si se descarga el paquete desde github, se puede instalar para que estÃ© disponible para python (en lib/site-packages). Para ello, desde la consola de comandos (cmd en Windows):
        
        ```
        $ cd ruta_del_proyecto
        $ pip install .
        
        ```
        
        o bien con el mÃ©todo antiguo (menos recomendable):
        
        ```
        $ cd ruta_del_proyecto
        $ python setup.py install
        ```
        ruta\_del\_proyecto es la carpeta del proyecto (la que contine el setup.py)
        
        ## Uso de tormetron
        
        Para descargar imÃ¡genes de radar de la API de AEMET es necesario obtener antes una API_KEY de [AEMET](https://opendata.aemet.es/centrodedescargas/altaUsuario)
        
        ### Uso en linea de comandos
        
            $ python -m radatron [ options ]
            
        &nbsp;&nbsp;&nbsp;&nbsp;options:
        
        --radar n
        &nbsp;&nbsp;n: &nbsp;&nbsp;1 ultimo radar
        &nbsp;&nbsp;2 acum de las ultimas 6 horas
        
        --estacion nombre
        &nbsp;&nbsp;nombre: nombre o codigo de la estaciÃ³n radar; por defecto, Palencia
        
        --modo m
        &nbsp;&nbsp;m: &nbsp;&nbsp;p descarga puntual
        &nbsp;&nbsp;c descarga programada la cada 10 minutos -Ãºltimo radar- o 24 horas -acum de las Ãºltimas 6 horas-
        
        --carpeta dir
        &nbsp;&nbsp;dir: nombre de la carpeta en la que guardar las imÃ¡genes; por defecto, "data"
        			
        Los comandos se puede abreviar respectivamente: -r, -e, -m, -c
        
        Ejemplos:
        
        ```  
        $ python -m radatron -r 2 -e Palencia -m c --carpeta radarPalencia
        
        $ python -m radatron --radar 1 --estacion Madrid
        ```
        
        ### Uso desde un script de python:
        
        Para usarlo desde un script el paquete debe estar instalado en site-packages o estar disponible para el script de forma que pueda importarse el paquete radatron:
        
        ```
        	>>> import radatron
        
        	>>> estacion_radar = radatron.EstacionRadar('Palencia')
        
        	>>> imagen_radar = radatron.ImagenRadarAEMET(estacion_radar)
        
        	>>> imagen_radar.descargar_mapa_radar_regional()
        ```
        
        TODO: Pendiente completar las instrucciones
        
        
        ## OrganizaciÃ³n interna
        
        Tormetron incluye un paquete llamado __tormetron__ con un mÃ³dulo principal, _radares.py_, que tiene tres clases:
        
        - Class EstacionRadar     -> Incluye mÃ©todos para buscar/identificar una estaciÃ³n radar
          
        - Class ImagenRadarAEMET  -> Incluye mÃ©todos para descargar imÃ¡genes radar de AEMET
        
        - Class ImagenRadarFile   -> Con mÃ©todos para procesar georreferenciar imÃ¡genes descargadas
        
        Las clases y sus mÃ©todos se documentarÃ¡n prÃ³ximamente.
        
        El script \_\_main\_\_.py utiliza estas clases para:
        
         * Obtener imagen(es) rÃ¡dar
        
          o bien:
        
         * Obtener imagen de precipitaciÃ³n de las Ãºltimas 6 horas
            
        En ambos casos se puede descargar:
        		
         * 0 Modo puntual: ultima imagen disponible
        			
         * 1 Modo continuo: descarga la imagen disponble cada 10 minutos (tiempo de actualizaciÃ³n)
        
        En el caso del radar, AEMET actualiza la imagen cada 10 minutos. Para la imagen de precipitaciÃ³nde las Ãºltimas horas, AEMET ofrece las Ãºltimas 8 imagenes, correspondientes a los 4 momentos de referencia del dÃ­a (AEMET genera estas imÃ¡genes a las 00:00, 06:00, 12:00 y 18:00 cada dÃ­a).
        
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Win32 (MS Windows)
Classifier: Environment :: X11 Applications
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: Spanish
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Classifier: Topic :: Scientific/Engineering :: GIS
Description-Content-Type: text/markdown
