neural_operators
================

Neural operators (DeepONet, PCANet, FNO) and the supporting infrastructure
(PDE forward models, Gaussian priors, MCMC, plotting) used to apply them to
parametric PDE problems.

Applications (survey article, book chapter) live in a separate repo,
`applications_neural_operators <https://github.com/CEADpx/applications_neural_operators>`_.

Installation
------------

FEniCSx (``dolfinx``, ``ufl``, ``petsc4py``, ``mpi4py``) and PyTorch are
installed from ``conda-forge``, not pip -- see the
`README <https://github.com/CEADpx/neural_operators#installation>`_ for why.

.. code-block:: bash

   conda env create -f neuralop.yml
   conda activate neuralopv2

API reference
-------------

.. toctree::
   :maxdepth: 2

   api/data
   api/pde
   api/prior
   api/nn
   api/mcmc
   api/plotting