.. _f-carreau:

module ``datasets.carreau``
===========================





.. inheritance-diagram:: papierstat.datasets.carreau


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

module ``papierstat.datasets.carreau``

Jeux de données reliés aux données carroyées.


:githublink:`%|py|6`




Classes
+++++++

+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| class                                                          | truncated documentation                                                                                                  |
+================================================================+==========================================================================================================================+
| :class:`DBFInMemory <papierstat.datasets.carreau.DBFInMemory>` | Overwrites `DBF <https://github.com/olemb/dbfread/blob/master/dbfread/dbf.py#L77>`_ to read data from memory and not ... |
+----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| function                                                                                    | truncated documentation                                                                                                                                                                   |
+=============================================================================================+===========================================================================================================================================================================================+
| :func:`_read_geopandas_from_bytes <papierstat.datasets.carreau._read_geopandas_from_bytes>` | Returns a :epkg:`GeoDataFrame` from two sequences of bytes, one for file *.mif*, one from file *.mid*. Unfortunately, ...                                                                 |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_carreau_from_zip <papierstat.datasets.carreau.load_carreau_from_zip>`           | Retourne un exemple de données carroyées. Les données sont disponibles dans le répertoire `data <https://github.com/sdpython/papierstat/tree/master/ src/papierstat/datasets/data>`_. ... |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_dbf_from_zip <papierstat.datasets.carreau.load_dbf_from_zip>`                   | Loads a *.dbf* file compressed into a zip file. It only takes the first *.dbf* file from the zip.                                                                                         |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :func:`load_shapes_from_zip <papierstat.datasets.carreau.load_shapes_from_zip>`             | Loads a *.mif* and a *.mid* file compressed into a zip file. It only takes the first *.mid* and *.mif* files from the ...                                                                 |
+---------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+




Properties
++++++++++

+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| property                                                              | truncated documentation                                                                                                  |
+=======================================================================+==========================================================================================================================+
| :meth:`dbversion <papierstat.datasets.carreau.DBFInMemory.dbversion>` |                                                                                                                          |
+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :meth:`deleted <papierstat.datasets.carreau.DBFInMemory.deleted>`     | Deleted records. When loaded a list of records, when not loaded a new ``RecordIterator`` object.                         |
+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :meth:`loaded <papierstat.datasets.carreau.DBFInMemory.loaded>`       | ``True`` if records are loaded into memory.                                                                              |
+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :meth:`records <papierstat.datasets.carreau.DBFInMemory.records>`     | Records (not included deleted ones). When loaded a list of records, when not loaded a new ``RecordIterator`` object. ... |
+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+----------------------------------------------------------------------------------+-------------------------+
| method                                                                           | truncated documentation |
+==================================================================================+=========================+
| :py:meth:`__init__ <papierstat.datasets.carreau.DBFInMemory.__init__>`           |                         |
+----------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_iter_records <papierstat.datasets.carreau.DBFInMemory._iter_records>` |                         |
+----------------------------------------------------------------------------------+-------------------------+


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

.. automodule:: papierstat.datasets.carreau
    :members:
    :special-members: __init__
    :show-inheritance: