# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "soilFlux" in publications use:'
type: software
license: MIT
title: 'soilFlux: Physics-Informed Neural Networks for Soil Water Retention Curves'
version: 0.1.5
doi: 10.5281/zenodo.18990856
identifiers:
- type: doi
  value: 10.32614/CRAN.package.soilFlux
abstract: 'Implements a physics-informed one-dimensional convolutional neural network
  (CNN1D-PINN) for estimating the complete soil water retention curve (SWRC) as a
  continuous function of matric potential, from soil texture, organic carbon, bulk
  density, and depth. The network architecture ensures strict monotonic decrease of
  volumetric water content with increasing suction by construction, through cumulative
  integration of non-negative slope outputs (monotone integral architecture). Four
  physics-based residual constraints adapted from Norouzi et al. (2025) <https://doi.org/10.1029/2024WR038149>
  are embedded in the loss function: (S1) linearity at the dry end (pF in [5, 7.6]);
  (S2) non-negativity at pF = 6.2; (S3) non-positivity at pF = 7.6; and (S4) a near-zero
  derivative in the saturated plateau region (pF in [-2, -0.3]). Includes tools for
  data preparation, model training, dense prediction, performance metrics, texture
  classification, and publication-quality visualisation.'
authors:
- family-names: Rodrigues
  given-names: Hugo
  email: rodrigues.machado.hugo@gmail.com
  orcid: https://orcid.org/0000-0002-8070-8126
preferred-citation:
  type: manual
  title: 'soilFlux: Physics-Informed Neural Networks for Soil Water Retention Curves'
  authors:
  - family-names: Rodrigues
    given-names: Hugo
    email: rodrigues.machado.hugo@gmail.com
    orcid: https://orcid.org/0000-0002-8070-8126
  year: '2026'
  notes: R package version 0.1.1
  url: https://github.com/HugoMachadoRodrigues/soilFlux
  doi: 10.5281/zenodo.18990856
repository: https://hugomachadorodrigues.r-universe.dev
repository-code: https://github.com/HugoMachadoRodrigues/soilFlux
commit: 12219c6da403cb564b6f1648191d468c4dab931d
url: https://hugomachadorodrigues.github.io/soilFlux/
date-released: '2026-03-23'
contact:
- family-names: Rodrigues
  given-names: Hugo
  email: rodrigues.machado.hugo@gmail.com
  orcid: https://orcid.org/0000-0002-8070-8126
references:
- type: article
  title: Physics-Informed Neural Networks for Estimating a Continuous Form of the
    Soil Water Retention Curve
  authors:
  - family-names: Norouzi
    given-names: Amir M.
  - family-names: Feyereisen
    given-names: Gary W.
  - family-names: Papanicolaou
    given-names: A. N.
  - family-names: Wilson
    given-names: C. G.
  journal: Journal of Hydrology
  year: '2025'
  notes: The paper on which the CNN1D-PINN architecture is based