Metadata-Version: 2.4
Name: pycequeau
Version: 0.1.2
Summary: A library that obtains the necessary files to build and run the CEQUEAU hydrological-water temperature model
Author-email: Eisinhower Rincon <eisinhower.rincon@inrs.ca>
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Hydrology
License-File: LICENSE
Requires-Dist: pyproj
Requires-Dist: xarray
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: shapely
Requires-Dist: geopandas
Requires-Dist: rasterstats
Requires-Dist: netcdf4
Requires-Dist: pytest
Requires-Dist: autopep8
Requires-Dist: ipykernel
Requires-Dist: rioxarray
Requires-Dist: dask
Requires-Dist: xarray-spatial
Requires-Dist: toml ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: autopep8 ; extra == "dev"
Requires-Dist: ipykernel ; extra == "dev"
Requires-Dist: sphinx ; extra == "dev"
Requires-Dist: sphinx-rtd-theme ; extra == "dev"
Requires-Dist: sphinx-copybutton ; extra == "dev"
Requires-Dist: nbsphinx ; extra == "dev"
Requires-Dist: sphinx-autodoc-typehints ; extra == "dev"
Requires-Dist: sphinx-mathjax-offline ; extra == "dev"
Project-URL: Documentation, https://pycequeau.readthedocs.io/
Project-URL: Homepage, https://github.com/erinconv/pycequeau
Project-URL: Repository, https://github.com/erinconv/pycequeau
Provides-Extra: dev

pycequeau
=======================================

Pycequeau is a library that obtains the necessary files to build and run the CEQUEAU hydrological-water temperature model.

To use this library it is highly recommended to clone the repository and create a fresh conda environment to have all the needed dependencies. To avoid compatibility issues, the new conda enviroment must contain a specific version of the GDAL library.

.. code-block:: bash
    
    conda create -n pycequeau python=3.10 gdal=3.11.0

Then, the package can be installed using the following command:

.. code-block:: bash

    pip install pycequeau

Alternatively, you can build and install the package from the source code by copying the git repository into your local machine and running the following command:

.. code-block:: bash

    git clone https://github.com/erinconv/pycequeau.git
    cd pycequeau
    pip install .

The tutorials and examples on how to use the library can be found in: https://pycequeau.readthedocs.io/en/latest/. The documentation is still under development, so any feedback/suggestions or contributions are welcome.
