Skip to content
Snippets Groups Projects
Commit e06bce03 authored by Stephan Seitz's avatar Stephan Seitz
Browse files

Extend README.rst, index.rst

parent 56098e15
No related branches found
No related tags found
No related merge requests found
Pipeline #17054 failed
...@@ -15,10 +15,12 @@ ...@@ -15,10 +15,12 @@
pystencils_autodiff pystencils_autodiff
=================== ===================
This repo add automatic differentiation to `pystencils <https://i10git.cs.fau.de/seitz/pystencils>`_.
Installation Installation
------------ ------------
Install via pip : Install via pip:
.. code-block:: bash .. code-block:: bash
...@@ -30,6 +32,11 @@ or if you downloaded this `repository <https://github.com/theHamsta/pystencils_a ...@@ -30,6 +32,11 @@ or if you downloaded this `repository <https://github.com/theHamsta/pystencils_a
pip install -e . pip install -e .
Then, you can access the submodule `pystencils.autodiff`.
.. code-block:: python
import pystencils.autodiff
Usage Usage
----- -----
......
...@@ -4,8 +4,11 @@ pystencils-autodiff ...@@ -4,8 +4,11 @@ pystencils-autodiff
This is the documentation of **pystencils-autodiff**. This is the documentation of **pystencils-autodiff**.
Installation This document assumes that you are already familiar with `pystencils <https://i10git.cs.fau.de/seitz/pystencils>`_.
------------ If not, here is a good `tutorial to start <http://pycodegen.pages.walberla.net/pystencils/notebooks/01_tutorial_getting_started.html>`_.
Installation of this Auto-Diff Extension
----------------------------------------
Install via pip : Install via pip :
...@@ -23,6 +26,9 @@ or if you downloaded this `repository <https://github.com/theHamsta/pystencils_a ...@@ -23,6 +26,9 @@ or if you downloaded this `repository <https://github.com/theHamsta/pystencils_a
Usage Usage
----- -----
This tutorial assumes that you are already familiar with pystencils.
If not here is a good point to `start <http://pycodegen.pages.walberla.net/pystencils/notebooks/01_tutorial_getting_started.html>`_.
Create a :class:`pystencils.AssignmentCollection` with pystencils: Create a :class:`pystencils.AssignmentCollection` with pystencils:
.. testcode:: .. testcode::
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment