folivo/PINA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixing documentation issues

Browse Source
This commit is contained in:
Dario Coscia
2024-09-03 17:27:26 +02:00
committed by Nicola Demo
parent 1aca017e1d
commit 25dc5693ff
4 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/_rst/_installation.rst
View File

@@ -1,7 +1,7 @@
Installation 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 Installing via PIP
__________________ __________________
@@ -11,13 +11,13 @@ To install the package just type:
.. code-block:: bash .. code-block:: bash
$ pip install git+https://github.com/mathLab/PINA.git $ pip install pina-mathlab
To uninstall the package: To uninstall the package:
.. code-block:: bash .. code-block:: bash
$ pip uninstall pina $ pip uninstall pina-mathlab
Installing from source Installing from source
______________________ ______________________

5
docs/source/conf.py
View File

@@ -74,8 +74,7 @@ intersphinx_mapping = {
'python': ('http://docs.python.org/3', None), 'python': ('http://docs.python.org/3', None),
# 'numpy': ('http://docs.scipy.org/doc/numpy/', None), # 'numpy': ('http://docs.scipy.org/doc/numpy/', None),
# 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', 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), 'torch': ('https://pytorch.org/docs/stable/', None),
'pytorch_lightning': ("https://lightning.ai/docs/pytorch/stable/", None), 'pytorch_lightning': ("https://lightning.ai/docs/pytorch/stable/", None),
} }
@@ -217,7 +216,7 @@ html_theme_options = {
}, },
{ {
"name": "Email", "name": "Email",
"url": "pina.mathlab@gmail.com", "url": "mailto:pina.mathlab@gmail.com",
"icon": "fas fa-envelope", "icon": "fas fa-envelope",
"type": "fontawesome", "type": "fontawesome",
}, },

4
docs/source/index.rst
View File

@@ -40,7 +40,7 @@ Welcome to PINA’s documentation!
.. grid:: 1 1 3 3 .. grid:: 1 1 3 3
.. grid-item:: .. grid-item::
:columns: 12 12 6 6 :columns: 12 12 8 8
Physics Informed Neural network for Advanced modeling (**PINA**) is Physics Informed Neural network for Advanced modeling (**PINA**) is
an open-source Python library providing an intuitive interface for 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.

2
setup.py
View File

@@ -19,7 +19,7 @@ REQUIRED = [
] ]
EXTRAS = { EXTRAS = {
'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_copybutton'], 'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_copybutton', 'sphinx_design'],
'test': ['pytest', 'pytest-cov'], 'test': ['pytest', 'pytest-cov'],
} }