Documentation for v0.1 version (#199)
* Adding Equations, solving typos * improve _code.rst * the team rst and restuctore index.rst * fixing errors --------- Co-authored-by: Dario Coscia <dariocoscia@dhcp-015.eduroam.sissa.it>
This commit is contained in:
committed by
Nicola Demo
parent
3f9305d475
commit
8b7b61b3bd
@@ -1,13 +1,6 @@
|
||||
Welcome to PINA's documentation!
|
||||
===================================================
|
||||
|
||||
.. figure:: index_files/pina_logo.png
|
||||
:align: center
|
||||
:width: 150
|
||||
|
||||
|
|
||||
|
||||
|
||||
Physics Informed Neural network for Advanced modeling (**PINA**) is
|
||||
an open-source Python library providing an intuitive interface for
|
||||
solving differential equations using PINNs, NOs or both together.
|
||||
@@ -29,7 +22,7 @@ with PINA follows just five steps: problem definition, model selection, data gen
|
||||
.. figure:: index_files/API_color.png
|
||||
:alt: PINA application program interface
|
||||
:align: center
|
||||
:width: 500
|
||||
:width: 600
|
||||
|
||||
|
|
||||
|
||||
@@ -54,12 +47,10 @@ terms), without the need of re-training.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
:caption: Package Documentation:
|
||||
|
||||
|
||||
API <_rst/_code>
|
||||
Contributing <_rst/_contributing>
|
||||
License <_LICENSE.rst>
|
||||
|
||||
.. the following is demo content intended to showcase some of the features you can invoke in reStructuredText
|
||||
.. this can be safely deleted or commented out
|
||||
@@ -67,8 +58,16 @@ terms), without the need of re-training.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:numbered:
|
||||
:caption: Getting Started:
|
||||
|
||||
Installation <_rst/_installation>
|
||||
Tutorials <_rst/_tutorials>
|
||||
Tutorials <_rst/_tutorial>
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Community:
|
||||
|
||||
Team & Foundings <_team.rst>
|
||||
Contributing <_rst/_contributing>
|
||||
License <_LICENSE.rst>
|
||||
Cite PINA <_cite.rst>
|
||||
Reference in New Issue
Block a user