Metadata-Version: 2.4
Name: diffwofost
Version: 0.3.0
Summary: Differentiable WOFOST
Author: Francesco Nattino, Ron van Bree
Author-email: Sarah Alidoost <f.alidoost@esciencecenter.nl>, Michiel Kallenberg <michiel.kallenberg@wur.nl>
License: **EUPL, Version 1.1**
        
        Licensed under the EUPL, Version 1.1 or as soon they
        will be approved by the European Commission - subsequent
        versions of the EUPL (the "Licence").
        
        You may not use this work except in compliance with the
        Licence.
        You may obtain a copy of the Licence at:
        
        https://interoperable-europe.ec.europa.eu/licence/european-union-public-licence-version-11-eupl
        Unless required by applicable law or agreed to in
        writing, software distributed under the Licence is
        distributed on an "AS IS" basis,
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
        express or implied.
        
        See the Licence for the specific language governing
        permissions and limitations under the Licence.
        
Project-URL: Repository, https://github.com/WUR-AI/diffwofost
Project-URL: Issues, https://github.com/WUR-AI/diffwofost/issues
Keywords: wofost,pytorch,differentiable,crop,optimization
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch
Requires-Dist: pcse
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs; extra == "docs"
Requires-Dist: mkdocs-material; extra == "docs"
Requires-Dist: mkdocs-jupyter; extra == "docs"
Requires-Dist: mkdocstrings[python]>=0.18; extra == "docs"
Requires-Dist: mkdocs-gen-files; extra == "docs"
Requires-Dist: mkdocs-include-markdown-plugin; extra == "docs"
Requires-Dist: jupyterlab; extra == "docs"
Requires-Dist: matplotlib; extra == "docs"
Dynamic: license-file

<!-- (Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.) -->

[![github repo badge](https://img.shields.io/badge/github-repo-000.svg?logo=github&labelColor=gray&color=blue)](https://github.com/WUR-AI/diffWOFOST)
[![PyPI - Version](https://badge.fury.io/py/diffwofost.svg)](https://img.shields.io/pypi/v/diffwofost)
[![Python package built](https://github.com/WUR-AI/diffWOFOST/actions/workflows/build.yml/badge.svg)](https://github.com/WUR-AI/diffWOFOST/actions/workflows/build.yml)
[![Documentation built](https://github.com/WUR-AI/diffWOFOST/actions/workflows/deploy-documentation.yml/badge.svg)](https://github.com/WUR-AI/diffWOFOST/actions/workflows/deploy-documentation.yml)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=WUR-AI_diffWOFOST&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=WUR-AI_diffWOFOST)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17474960.svg)](https://doi.org/10.5281/zenodo.17474960)

![diffWOFOST banner](https://raw.githubusercontent.com/WUR-AI/diffWOFOST/main/docs/logo/diffwofost_banner.png)

# diffWOFOST


<div style="display: flex; align-items: center; justify-content: space-between;">

<div style="flex: 1; padding-right: 1rem;">

The python package `diffWOFOST` is a differentiable implementation of WOFOST models using [`torch`](https://pytorch.org/), allowing gradients to flow through the simulations for optimization and data assimilation.


</div>

<img src="./docs/logo/diffwofost.png" width="120" alt="Logo" />

</div>


## Installation

You can install `diffWOFOST` using pip:

```bash
pip install diffwofost
```

To install the package in development mode, you can clone the repository and
install it using pip:

```bash
pip install -e .[dev]
```

To work with notebooks, you need to install `jupyterlab`:

```bash
pip install jupyterlab
```

## Documentation

The documentation for `diffWOFOST` is available at
[https://WUR-AI.github.io/diffWOFOST](https://WUR-AI.github.io/diffWOFOST).

## Acknowledgements

The package `diffWOFOST` is developed in the
[DeltaCrop](https://research-software-directory.org/projects/deltacrop) project, a
collaboration between Wageningen University & Research and Netherlands eScience
Center.
