.. _f-datajcdecaux:

module ``velib.data_jcdecaux``
==============================





.. inheritance-diagram:: manydataapi.velib.data_jcdecaux


Short summary
+++++++++++++

module ``manydataapi.velib.data_jcdecaux``

The file contains a class which collects data coming from :epkg:`Velib`.



:githublink:`%|py|7`




Classes
+++++++

+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                              | truncated documentation                                                                                                                                   |
+====================================================================================+===========================================================================================================================================================+
| :class:`DataCollectJCDecaux <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux>` | This class automates data collecting from :epkg:`JCDecaux`. The service is provided at `JCDecaux developer <https://developer.jcdecaux.com/#/home>`_. ... |
+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+








Static Methods
++++++++++++++

+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| staticmethod                                                                                        | truncated documentation                                                                                                                                |
+=====================================================================================================+========================================================================================================================================================+
| :meth:`animation <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.animation>`                   | Displays a javascript animation, see `animation.FuncAnimation <http://matplotlib.org/api/animation_api.html#matplotlib.animation.FuncAnimation>`_. ... |
+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`distance_haversine <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.distance_haversine>` | Computes the `haversine <https://en.wikipedia.org/wiki/Haversine_formula>`_ distance.                                                                  |
+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`draw <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.draw>`                             | Draws a graph using four columns: *lng*, *lat*, *available_bike_stands*, *available_bikes*.                                                            |
+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`run_collection <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.run_collection>`         | Runs the collection of the data for velib, data are stored using :epkg:`json` format. The function creates a file ...                                  |
+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`simulate <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.simulate>`                     | Simulates velibs on a set of stations given by *df*.                                                                                                   |
+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`to_df <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.to_df>`                           | Reads all files in a folder (assuming there were produced by this class) and returns a dataframe with it.                                              |
+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+




Methods
+++++++

+-----------------------------------------------------------------------------------------------+--------------------------------------------+
| method                                                                                        | truncated documentation                    |
+===============================================================================================+============================================+
| :py:meth:`__init__ <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.__init__>`            |                                            |
+-----------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`collecting_data <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.collecting_data>` | Collects data for a period of time.        |
+-----------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`get_contracts <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.get_contracts>`     | Returns the list of contracts.             |
+-----------------------------------------------------------------------------------------------+--------------------------------------------+
| :meth:`get_json <manydataapi.velib.data_jcdecaux.DataCollectJCDecaux.get_json>`               | Returns the data associated to a contract. |
+-----------------------------------------------------------------------------------------------+--------------------------------------------+


Documentation
+++++++++++++

.. automodule:: manydataapi.velib.data_jcdecaux
    :members:
    :special-members: __init__
    :show-inheritance: