.. image:: _static/AxisVM_logo.bmp

=====================================================
**PyAxisVM** - The official Python package for AxisVM
=====================================================

.. toctree::
   :maxdepth: 1
   :hidden:

   getting_started
   User Guide <user_guide>
   Gallery <examples_gallery>
   API Reference <api>

**Version**: |version|

**Useful links**:
:doc:`getting_started` |
:doc:`user_guide` |
:doc:`examples_gallery` |
:ref:`API Reference` |
:ref:`tips-and-tricks` |
`Source Repository <https://github.com/AxisVM/pyaxisvm>`_

The **PyAxisVM** project offers a high-level interface to **AxisVM**, 
making its operations available directly from Python. It builds on top of 
Microsoft's COM technology and supports all the features of the original 
**AxisVM** COM type library.

Highlights
==========

* Build, manipulate and analyse **AxisVM** models.
* Find better solutions with iterative methods.
* Combine the power of **AxisVM** with your favourite Python libraries you already love.
* Build extension modules.
* And many more neither of us know about yet.

On top of that, **PyAxisVM** enhances the type library with Python's slicing 
mechanism, context management and more, that helps you to write clean, concise, 
and readable code.

Installation
============

You can install the project from PyPI with `pip`:

.. code-block:: shell

   $ pip install axisvm

Contents
========

.. grid:: 2
    
    .. grid-item-card::
        :img-top: ../source/_static/index-images/getting_started.svg

        Getting Started
        ^^^^^^^^^^^^^^^

        The getting started guide helps you to make the first steps to get
        to know the library.

        +++

        .. button-ref:: getting_started
            :expand:
            :color: secondary
            :click-parent:

            Get me started

    .. grid-item-card::
        :img-top: ../source/_static/index-images/user_guide.svg

        User Guide
        ^^^^^^^^^^

        The user guide contains a basic introduction to the main concepts 
        through simple examples.

        +++

        .. button-ref:: user_guide
            :expand:
            :color: secondary
            :click-parent:

            To the user guide

    .. grid-item-card::
        :img-top: ../source/_static/index-images/api.svg

        API Reference
        ^^^^^^^^^^^^^

        The reference guide contains a detailed description of the functions,
        modules, and objects included in the library. The reference describes how the
        methods work and which parameters can be used. It assumes that you have an
        understanding of the key concepts.

        +++

        .. button-ref:: api
            :expand:
            :color: secondary
            :click-parent:

            To the reference guide

    .. grid-item-card::
        :img-top: ../source/_static/index-images/gallery.svg

        Examples Gallery
        ^^^^^^^^^^^^^^^^

        A gallery of examples that illustrate uses cases that involve some
        kind of visualization.

        +++

        .. button-ref:: examples_gallery
            :expand:
            :color: secondary
            :click-parent:

            To the examples gallery
   

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`