Introduction
============

**croco_pytools** is a Python toolbox for preprocessing, postprocessing, 
and visualizing CROCO inputs and outputs.

It is available on gitlab: https://gitlab.inria.fr/croco-ocean/croco_pytools

And its online documentation can be displayed at: 
https://croco-ocean.gitlabpages.inria.fr/croco_pytools

The repository consists of several parts :

* **prepro**: a set of python routines (and embedded fortran tools), to prepare 
  the files needed by CROCO for running realistic simulations:
  grid, initial and boundary conditions, atmospheric, tides, and rivers forcings
* **croco_pyvisu**: a graphical visualization interface for CROCO outputs
* **xcroco**: a toolkit for analyzing CROCO results based on xarray and xgcm
* **doc**: the associated documentation

.. warning:: 

    These tools bring together methods from several
    users in the CROCO community, but do not constitute a definitive toolkit.
    Not all features available in matlab croco_tools
    are available in this version.

    A new, more advanced toolkit is currently being developed by the CROCO 
    development team.


A global conda environment is available for the three parts 
of **croco_pytools** in the ``env.yml`` file, located at the root 
of the **croco_pytools** directory.

You can use your favorite python environment manager 
(e.g. conda, mamba, micromamba, miniforge)
to install the environment named ``croco_pyenv`` with this file.

Example with micromamba :

::

    micromamba create -f env.yml
    micromamba activate croco_pyenv

Example with conda :

::

    conda env create -f env.yml
    conda activate croco_pyenv

.. tip::

    You can make available your ``croco_pyenv`` kernel for 
    Jupyter Notebook by using the command : 
    ``ipython kernel install --user --name=croco_pyenv``