fixing documentation issues
This commit is contained in:
committed by
Nicola Demo
parent
1aca017e1d
commit
25dc5693ff
@@ -1,7 +1,7 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
**PINA** requires requires `numpy`, `scipy`, `matplotlib`, `future`, `torch`, `sphinx` (for the documentation) and `pytest` (for local test). The code is tested for Python 3, while compatibility of Python 2 is not guaranteed anymore. It can be installed using `pip` or directly from the source code.
|
||||
**PINA** requires requires `numpy`, `matplotlib`, `torch`, `lightning`, `sphinx` (for the documentation) and `pytest` (for local test). The code is tested for Python 3, while compatibility of Python 2 is not guaranteed anymore. It can be installed using `pip` or directly from the source code.
|
||||
|
||||
Installing via PIP
|
||||
__________________
|
||||
@@ -11,13 +11,13 @@ To install the package just type:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip install git+https://github.com/mathLab/PINA.git
|
||||
$ pip install pina-mathlab
|
||||
|
||||
To uninstall the package:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ pip uninstall pina
|
||||
$ pip uninstall pina-mathlab
|
||||
|
||||
Installing from source
|
||||
______________________
|
||||
|
||||
@@ -74,8 +74,7 @@ intersphinx_mapping = {
|
||||
'python': ('http://docs.python.org/3', None),
|
||||
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
|
||||
# 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
|
||||
'matplotlib': ('http://matplotlib.sourceforge.net/', None),
|
||||
# 'matplotlib': ('https://matplotlib.org/stable', None),
|
||||
'matplotlib': ('https://matplotlib.org/stable', None),
|
||||
'torch': ('https://pytorch.org/docs/stable/', None),
|
||||
'pytorch_lightning': ("https://lightning.ai/docs/pytorch/stable/", None),
|
||||
}
|
||||
@@ -217,7 +216,7 @@ html_theme_options = {
|
||||
},
|
||||
{
|
||||
"name": "Email",
|
||||
"url": "pina.mathlab@gmail.com",
|
||||
"url": "mailto:pina.mathlab@gmail.com",
|
||||
"icon": "fas fa-envelope",
|
||||
"type": "fontawesome",
|
||||
},
|
||||
|
||||
@@ -40,7 +40,7 @@ Welcome to PINA’s documentation!
|
||||
.. grid:: 1 1 3 3
|
||||
|
||||
.. grid-item::
|
||||
:columns: 12 12 6 6
|
||||
:columns: 12 12 8 8
|
||||
|
||||
Physics Informed Neural network for Advanced modeling (**PINA**) is
|
||||
an open-source Python library providing an intuitive interface for
|
||||
@@ -52,7 +52,7 @@ Welcome to PINA’s documentation!
|
||||
|
||||
|
||||
|
||||
Contact us by email for further information or questions about **PINA**, or suggest pull requests.
|
||||
For further information or questions about **PINA** contact us by email.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user