.. _pfs-examples:

========
Examples
========

This section provides a practical example demonstrating NeurEco PFS models using a test case included with the NeurEco installation package.

.. toctree::
   :maxdepth: 1
   :caption: PFS Examples

   frequency-selective-surface

Test Case Overview
==================

NeurEco includes the following PFS test case:

.. list-table::
   :header-rows: 1
   :widths: 30 70

   * - Test Case
     - Description
   * - :ref:`Frequency Selective Surface (FSS) <example-fss>`
     - Predicting TE/TM frequency response based on 5 design parameters

What You'll Learn
=================

This example demonstrates:

- **Data loading**: Working with complex-valued frequency response data
- **Building**: Configuring and training a PFS model
- **Checkpoints**: Exploring intermediate models to find accuracy/complexity trade-offs
- **Evaluation**: Computing errors and visualizing frequency responses
- **Best practices**: Working with complex outputs and frequency domain data

Getting Started
===============

To run the example:

1. Find the FSS test case's zip file, ``FrequencySelectiveSurface.zip``. On Windows it is in ``<install folder>\testsuite\`` (by default ``C:\Program Files\Adagos\NeurEco-5.0\testsuite\``); on Linux, in ``/opt/neureco/share/adagos/.neurecotestsuite/``. The pip package does not include the examples (see :ref:`tabular-examples`)
2. Extract the zip file to a working directory, or open the example from the desktop app's example gallery
3. Copy the example code and modify paths as needed
4. Run the script to build and evaluate the model