<!--
SPDX-FileCopyrightText: 2025 Helmholtz-Zentrum hereon GmbH

SPDX-License-Identifier: CC-BY-4.0
-->

<!--
dasf-exb-reference documentation master file
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-->

# Welcome to dasf-exb-reference's documentation!

[![CI](https://codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference/badges/main/pipeline.svg)](https://codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference/-/pipelines?page=1&scope=all&ref=main)
[![Code coverage](https://codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference/badges/main/coverage.svg)](https://codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference/-/graphs/main/charts)
<!-- TODO: uncomment the following line when the package is registered at https://readthedocs.org -->
<!-- [![Docs](https://readthedocs.org/projects/dasf-exb-reference/badge/?version=latest)](https://dasf.readthedocs.io/projects/exb-reference/en/latest/) -->
[![Latest Release](https://codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference/-/badges/release.svg)](https://codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference)
<!-- TODO: uncomment the following line when the package is published at https://pypi.org -->
<!-- [![PyPI version](https://img.shields.io/pypi/v/dasf-exb-reference.svg)](https://pypi.python.org/pypi/dasf-exb-reference/) -->
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
<!-- TODO: uncomment the following line when the package is registered at https://api.reuse.software -->
<!-- [![REUSE status](https://api.reuse.software/badge/codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference)](https://api.reuse.software/info/codebase.helmholtz.cloud/dasf/demos/dasf-exb-reference) -->

**Reference implementation and Demonstration of a DASF Backend Module visualized by the dasf-experiencebuilder-plugin**

## About this project

This package provides several models to integrate a DASF backend module with the
frontend capabilities of an application built with the ArcGIS Experience Builder.

This package in particular defines reference models for modifying the HTML form
for the request (see {mod}`dasf_exb.input_models`), and for handling the output
of a model (see {mod}`dasf_exb.return_models`).

For example usage of the models provided here, please the the
{mod}`dasf_exb.backend` module, and visit the
{ref}`docs on the experience builder custom widget <exb-widget:quickstart>`.

```{toctree}
---
maxdepth: 2
caption: "Contents:"
---
installation
api
contributing
```

## How to cite this software

```{eval-rst}
.. card:: Please do cite this software!

   .. tab-set::

      .. tab-item:: APA

         .. citation-info::
            :format: apalike

      .. tab-item:: BibTex

         .. citation-info::
            :format: bibtex

      .. tab-item:: RIS

         .. citation-info::
            :format: ris

      .. tab-item:: Endnote

         .. citation-info::
            :format: endnote

      .. tab-item:: CFF

         .. citation-info::
            :format: cff
```

# License information

Copyright © 2025 Helmholtz-Zentrum hereon GmbH

The source code of dasf-exb-reference is licensed under Apache-2.0.

If not stated otherwise, the contents of this documentation is licensed
under CC-BY-4.0.

## Indices and tables

-   {ref}`genindex`
-   {ref}`modindex`
-   {ref}`search`