Metadata-Version: 2.1
Name: imod
Version: 0.6.0
Summary: Work with iMOD MODFLOW models
Home-page: https://gitlab.com/deltares/imod/imod-python
Author: Martijn Visser
Author-email: martijn.visser@deltares.nl
License: MIT
Description: Work with `iMOD <http://oss.deltares.nl/web/imod>`__ MODFLOW models in
        Python.
        
        Documentation: https://deltares.gitlab.io/imod/imod-python/
        
        Source code: https://gitlab.com/deltares/imod/imod-python
        
        Getting started
        ===============
        
        .. code:: python
        
            import imod
        
            # read and write IPF files to pandas DataFrame
            df = imod.ipf.read('wells.ipf')
            imod.ipf.save('wells-out.ipf', df)
        
            # get all calculated heads in a xarray DataArray
            # with dimensions time, layer, y, x
            da = imod.idf.open('path/to/results/head_*.idf')
        
        Introduction
        ============
        
        The imod Python package is an addition to iMOD and iMODFLOW, intended to facilitate
        working with groundwater models from Python. It does this by supporting reading and
        writing of the different iMOD file formats to existing objects often used in Python
        data processing.
        
        IDF - iMOD Data Format
        ----------------------
        IDF is the binary raster format of iMOD. One file contains a X and Y 2 dimensional grid.
        Using a set of file name conventions more dimensions such as ``time`` and ``layer`` are
        added, for example: ``head_20181113_l3.idf`` for layer 3 and timestamp ``2018-11-13``.
        This package maps IDF files to and from the N dimensional labeled arrays of
        `xarray.DataArray <http://xarray.pydata.org/en/stable/data-structures.html#dataarray>`__,
        using ``imod.idf.open`` and ``imod.idf.save``, or, to read multiple parameters
        at the same time, ``imod.idf.open_dataset``.
        
        For more information on how to work with ``xarray.DataArray`` objects, we refer to the
        xarray documentation. Note that converting GIS raster formats to IDF is supported
        through `xarray.open_rasterio <http://xarray.pydata.org/en/stable/generated/xarray.open_rasterio.html#xarray.open_rasterio>`__,
        followed by ``imod.idf.save``.
        
        IPF - iMOD Point File
        ---------------------
        IPF files are text files used for storing tabular point data such as timeseries and
        borehole measurements. In the imod Python package these files are read in as
        `pandas.DataFrame <https://pandas.pydata.org/pandas-docs/stable/>`__. Pandas is a
        popular package that makes analysis and processing of tabular data easy, and provides
        many input and output options, which in turn enables us to convert for instance
        existing CSV or Excel files to IPF files. The primary functions for reading and writing
        IPF files are ``imod.ipf.read`` and ``imod.ipf.save``.
        
        Authors
        =======
        This Python package was written primarily by Martijn Visser and Huite Bootsma at Deltares.
        
Keywords: imod modflow groundwater modeling
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Provides-Extra: optional
Provides-Extra: dev
