docs: add main page in package documentation

#' airGRccia: Climate Change Impact and Adaptation with airGRiwrm

#'

#' `airGRccia` provides tools to support Climate Change Impact and Adaptation (CCIA)

#' studies with semi-distributed hydrological modeling workflows based on `airGRiwrm`.

#'

#' @description

#' The package helps build reproducible CCIA workflows from watershed delineation and

#' hydroclimatic data preprocessing to model setup and uncertainty post-processing.

#'

#' @details

#' Typical workflow components include:

#'

#' - **Spatial preprocessing**:

#'   [watershed_get_from_outlet()], [extract_sub_basins()], [extract_reaches()],

#'   [sb_to_outlets()], [calc_hypso()]

#' - **Data acquisition and preprocessing**:

#'   [get_ign_dem()], [get_ign_streams()], [get_hubeau_flows()],

#'   [get_climate_safran()], [hydro_get_station()]

#' - **Model input preparation**:

#'   [CreateBasinsObs()]

#' - **Uncertainty and diagnostics**:

#'   [predict_uncertainty()], [predict_uncertainty_calibration()],

#'   [plot_uncertainty_calibration()], [plot_uncertainty_time_series()],

#'   [transfer_uncertainty()]

#' - **Utilities**:

#'   [getCachePath()], [getCacheDir()], [clearCache()], [get_future_workers()],

#'   [get_ram()]

#'

#' The package vignettes provide an end-to-end tutorial on the middle valley

#' of the Hérault River (France).

#'

#' @section Vignettes:

#' - `vignette("V01-Watershed_delineation", package = "airGRccia")`

#' - `vignette("V02-Hydroclimatic_preprocessing", package = "airGRccia")`

#' - `vignette("V03-Usages_preprocessing", package = "airGRccia")`

#' - `vignette("V04-Dam_releases_preprocessing", package = "airGRccia")`

#' - `vignette("V05-Hydrologic_model_calibration", package = "airGRccia")`

#'

#' @seealso

#' - Website: <https://airgriwrm.pages.forge.inrae.fr/airgrccia>

#' - R-universe: <https://inrae.r-universe.dev/airGRccia>

#' - Issues: <https://forge.inrae.fr/airgriwrm/airgrccia/-/issues>

#'

#' @name airGRccia

#' @aliases airGRccia-package

#' @keywords internal

"_PACKAGE"

% Generated by roxygen2: do not edit by hand

% Please edit documentation in R/airGRccia-package.R

\docType{package}

\name{airGRccia-package}

\alias{airGRccia}

\alias{airGRccia-package}

\title{airGRccia: Climate Change Impact and Adaptation with airGRiwrm}

\description{

\if{html}{\figure{logo.png}{options: style='float: right' alt='logo' width='120'}}

This package provides tools for studying climate Change Impact and Adaptation on a watershed modeled with airGRiwrm.

}

\seealso{

Useful links:

\itemize{

  \item \url{https://inrae.r-universe.dev/airGRccia}

  \item \url{https://airgriwrm.pages.forge.inrae.fr/airgrccia}

  \item Report bugs at \url{https://forge.inrae.fr/airgriwrm/airgrccia/-/issues}

}

}

\author{

\strong{Maintainer}: David Dorchies \email{david.dorchies@inrae.fr} (\href{https://orcid.org/0000-0002-6595-7984}{ORCID})

}

\keyword{internal}

% Generated by roxygen2: do not edit by hand

% Please edit documentation in R/airGRccia-package.R

\docType{package}

\name{airGRccia}

\alias{airGRccia}

\alias{airGRccia-package}

\title{airGRccia: Climate Change Impact and Adaptation with airGRiwrm}

\description{

The package helps build reproducible CCIA workflows from watershed delineation and

hydroclimatic data preprocessing to model setup and uncertainty post-processing.

}

\details{

\code{airGRccia} provides tools to support Climate Change Impact and Adaptation (CCIA)

studies with semi-distributed hydrological modeling workflows based on \code{airGRiwrm}.

Typical workflow components include:

\itemize{

\item \strong{Spatial preprocessing}:

\code{\link[=watershed_get_from_outlet]{watershed_get_from_outlet()}}, \code{\link[=extract_sub_basins]{extract_sub_basins()}}, \code{\link[=extract_reaches]{extract_reaches()}},

\code{\link[=sb_to_outlets]{sb_to_outlets()}}, \code{\link[=calc_hypso]{calc_hypso()}}

\item \strong{Data acquisition and preprocessing}:

\code{\link[=get_ign_dem]{get_ign_dem()}}, \code{\link[=get_ign_streams]{get_ign_streams()}}, \code{\link[=get_hubeau_flows]{get_hubeau_flows()}},

\code{\link[=get_climate_safran]{get_climate_safran()}}, \code{\link[=hydro_get_station]{hydro_get_station()}}

\item \strong{Model input preparation}:

\code{\link[=CreateBasinsObs]{CreateBasinsObs()}}

\item \strong{Uncertainty and diagnostics}:

\code{\link[=predict_uncertainty]{predict_uncertainty()}}, \code{\link[=predict_uncertainty_calibration]{predict_uncertainty_calibration()}},

\code{\link[=plot_uncertainty_calibration]{plot_uncertainty_calibration()}}, \code{\link[=plot_uncertainty_time_series]{plot_uncertainty_time_series()}},

\code{\link[=transfer_uncertainty]{transfer_uncertainty()}}

\item \strong{Utilities}:

\code{\link[=getCachePath]{getCachePath()}}, \code{\link[=getCacheDir]{getCacheDir()}}, \code{\link[=clearCache]{clearCache()}}, \code{\link[=get_future_workers]{get_future_workers()}},

\code{\link[=get_ram]{get_ram()}}

}

The package vignettes provide an end-to-end tutorial on the middle valley

of the Hérault River (France).

}

\section{Vignettes}{

\itemize{

\item \code{vignette("V01-Watershed_delineation", package = "airGRccia")}

\item \code{vignette("V02-Hydroclimatic_preprocessing", package = "airGRccia")}

\item \code{vignette("V03-Usages_preprocessing", package = "airGRccia")}

\item \code{vignette("V04-Dam_releases_preprocessing", package = "airGRccia")}

\item \code{vignette("V05-Hydrologic_model_calibration", package = "airGRccia")}

}

}

\seealso{

\itemize{

\item Website: \url{https://airgriwrm.pages.forge.inrae.fr/airgrccia}

\item R-universe: \url{https://inrae.r-universe.dev/airGRccia}

\item Issues: \url{https://forge.inrae.fr/airgriwrm/airgrccia/-/issues}

}

}

\author{

\strong{Maintainer}: David Dorchies \email{david.dorchies@inrae.fr} (\href{https://orcid.org/0000-0002-6595-7984}{ORCID})

}

\keyword{internal}