From e06bce03be545dd081a5f8f675241060d3285352 Mon Sep 17 00:00:00 2001 From: Stephan Seitz <stephan.seitz@fau.de> Date: Thu, 8 Aug 2019 04:58:19 +0200 Subject: [PATCH] Extend README.rst, index.rst --- README.rst | 9 ++++++++- docs/index.rst | 10 ++++++++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index bb75740..d3415f5 100644 --- a/README.rst +++ b/README.rst @@ -15,10 +15,12 @@ pystencils_autodiff =================== +This repo add automatic differentiation to `pystencils <https://i10git.cs.fau.de/seitz/pystencils>`_. + Installation ------------ -Install via pip : +Install via pip: .. code-block:: bash @@ -30,6 +32,11 @@ or if you downloaded this `repository <https://github.com/theHamsta/pystencils_a pip install -e . +Then, you can access the submodule `pystencils.autodiff`. + +.. code-block:: python + + import pystencils.autodiff Usage ----- diff --git a/docs/index.rst b/docs/index.rst index bae284a..7e85c2d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,8 +4,11 @@ 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 : @@ -23,6 +26,9 @@ or if you downloaded this `repository <https://github.com/theHamsta/pystencils_a 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: .. testcode:: -- GitLab