Tutorials and Doc (#191)

* Tutorial doc update
* update doc tutorial
* doc not compiling

---------

Co-authored-by: Dario Coscia <dcoscia@euclide.maths.sissa.it>
Co-authored-by: Dario Coscia <dariocoscia@Dario-Coscia.local>
This commit is contained in:
Nicola Demo
2023-10-23 12:48:09 +02:00
parent ac829aece9
commit 0c8072274e
93 changed files with 2306 additions and 1685 deletions

View File

@@ -0,0 +1,77 @@
Code Documentation
==================
Welcome to PINA documentation! Here you can find the modules of the package divided in different sections.
PINA Features
-------
.. toctree::
:titlesonly:
LabelTensor <label_tensor.rst>
Condition <condition.rst>
Plotter <plotter.rst>
Problem
-------
.. toctree::
:titlesonly:
AbstractProblem <problem/abstractproblem.rst>
SpatialProblem <problem/spatialproblem.rst>
TimeDependentProblem <problem/timedepproblem.rst>
ParametricProblem <problem/parametricproblem.rst>
Solvers
-------
.. toctree::
:titlesonly:
SolverInterface <solvers/solver_interface.rst>
PINN <solvers/pinn.rst>
Models
-----
.. toctree::
:titlesonly:
Network <models/network.rst>
FeedForward <models/fnn.rst>
MultiFeedForward <models/multifeedforward.rst>
ResidualFeedForward <models/fnn_residual.rst>
DeepONet <models/deeponet.rst>
FNO <models/fno.rst>
Layers
------
.. toctree::
:titlesonly:
ContinuousConv <layers/convolution.rst>
Geometries
----------
.. toctree::
:titlesonly:
Location <geometry/location.rst>
CartesianDomain <geometry/cartesian.rst>
EllipsoidDomain <geometry/ellipsoid.rst>
SimplexDomain <geometry/simplex.rst>
Loss
------
.. toctree::
:titlesonly:
LossInterface <loss/loss_interface.rst>
LpLoss <loss/lploss.rst>
PowerLoss <loss/powerloss.rst>