pbrod/numdifftools

View on GitHub
docs/tutorials/index.rst

Summary

Maintainability
Test Coverage
.. _tutorials:

#########
Tutorials
#########

The pages in this section of the documentation are aimed at the newcomer to
numdifftools. They're designed to help you get started quickly, and show how
easy it is to work with numdifftools as a developer who wants to customise it and
get it working according to their own requirements.

These tutorials take you step-by-step through some key aspects of this work.
They're not intended to explain the :doc:`topics in depth </topics/index>`, or
provide :doc:`reference material </reference/index>`, but they will leave you
with a good idea of what it's possible to achieve in just a few steps, and how
to go about it.

Once you're familiar with the basics presented in these tutorials, you'll find
the more in-depth coverage of the same topics in the :doc:`How-to
</how-to/index>` section.

The tutorials follow a logical progression, starting from installation of numdifftools and the
creation of a brand new project, and build on each other, so it's recommended to work through them
in the order presented here.

.. toctree::
    :maxdepth: 1
    

    install
    getting_started
    whatsnext


.. seealso::

    Numdifftools is 100% Python_, so if you're new to Python_, you might want to start
    by getting an idea of what the language is like. Below we have given some pointers
    to some resources you can use to get acquainted with the language.

    If you're new to programming entirely, you might want to start with this
    `list of Python resources for non-programmers`_

    If you already know a few other languages and want to get up to speed with
    Python quickly, we recommend `Dive Into Python`_. If that's not quite your
    style, there are many other `books about Python`_.

    .. _python: https://python.org/
    .. _list of Python resources for non-programmers: https://wiki.python.org/moin/BeginnersGuide/NonProgrammers
    .. _Dive Into Python: https://www.diveinto.org/python3/
    .. _books about Python: https://wiki.python.org/moin/PythonBooks