.. title:: Getting Started
.. _getting_started:
Getting Started
+++++++++++++++
.. raw:: html
To get started with the package we first recommend getting acquainted with the
documentation structure to be able to quickly locate needed information. We
recommend following the documentation in the order given below to get the most
out of it.
1. :ref:`getting_started` -- this page.
a. :ref:`about_the_package` -- a brief overview of the package and its
structure.
b. :ref:`installation_instructions` -- information how to install the
package and what are its dependencies.
c. :ref:`citing` -- information how to cite the package and the user guide.
2. :ref:`tutorials` -- a series of hands-on tutorials that will walk you
through some basic use cases of the software.
3. :ref:`sphx_glr_sphinx_gallery_auto` -- code examples showing how some of
the main functionality of the package can be used.
4. :ref:`api_ref` -- describing every function and object of the package.
5. :ref:`how_to_guide` -- a series of guides describing how to achieve a
certain goal, e.g. implement a desired functionality, using the package.
6. :ref:`user_guide` -- a theoretical description of algorithms implemented by
the package including their strengths, weaknesses and best practices.
7. :ref:`news` -- news about the package.
8. :ref:`developers_guide` -- useful information for developers who want to
contribute to the package.
9. :ref:`contributors` -- a list of developers who contributed to the package.
10. :ref:`changelog` -- a list of changes introduce to the package with every
release.
11. :ref:`roadmap` -- a plan for the future development of the package.
----
.. note::
Additional learning resources are available on the FAT Forensics
`events website`_.
----
.. note::
If you use our package or the user guide please remember to
:ref:`cite us `.
----
.. note:: **Doctest Mode**
The code-examples in the :ref:`tutorials` and :ref:`how_to_guide` are
written in a *python-console* format. If you wish to easily execute these
examples in **IPython**, use the::
%doctest_mode
`magic command`_ in the IPython-console. You can then simply copy and paste
the examples directly into IPython without having to worry about removing
the `>>>` manually.
.. raw:: html
.. toctree::
:maxdepth: 2
:hidden:
structure
install_deps_os
cite
.. _`magic command`: https://ipython.readthedocs.io/en/stable/interactive/magics.html#magic-doctest_mode
.. _`events website`: https://events.fat-forensics.org/