diff --git a/docs/source/_rst/_installation.rst b/docs/source/_rst/_installation.rst index 0f6fdb9..eae78dc 100644 --- a/docs/source/_rst/_installation.rst +++ b/docs/source/_rst/_installation.rst @@ -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 ______________________ diff --git a/docs/source/conf.py b/docs/source/conf.py index a6fbc1e..d561030 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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", }, diff --git a/docs/source/index.rst b/docs/source/index.rst index d998c1c..eb15bea 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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. diff --git a/setup.py b/setup.py index 2aacaa1..d0a7352 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ REQUIRED = [ ] EXTRAS = { - 'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_copybutton'], + 'docs': ['sphinx', 'sphinx_rtd_theme', 'sphinx_copybutton', 'sphinx_design'], 'test': ['pytest', 'pytest-cov'], }