Skip to content

Commit

Permalink
fixing documentation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
dario-coscia authored and ndem0 committed Sep 3, 2024
1 parent 1aca017 commit 25dc569
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/source/_rst/_installation.rst
Original file line number Diff line number Diff line change
@@ -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
__________________
Expand All @@ -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
______________________
Expand Down
5 changes: 2 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,7 @@
'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),
}
Expand Down Expand Up @@ -217,7 +216,7 @@
},
{
"name": "Email",
"url": "[email protected]",
"url": "mailto:[email protected]",
"icon": "fas fa-envelope",
"type": "fontawesome",
},
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.



Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
]

EXTRAS = {
'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_copybutton'],
'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_copybutton', 'sphinx_design'],
'test': ['pytest', 'pytest-cov'],
}

Expand Down

0 comments on commit 25dc569

Please sign in to comment.