darkprop Python Package
=======================

We provide a Python package also called darkprop, which is a wrapper of the darkprop C++
library covering almost all APIs. The package can be installed via ``pip``

.. code-block:: bash

   $ pip install darkprop

.. tip::
   .. include:: ../../python/README.md
      :parser: myst_parser.sphinx_
      :start-after: **Tip**
      :end-before: ---

.. note::
   Currently only Linux and macOS (arm64) platforms are supported.

If there are problems with `pip install`, you can build the package from the source.
See ``python/README.md`` or `darkprop's pypi page <https://pypi.org/project/darkprop/>`_
for instructions.

Demonstration Jupyter notebooks can be found in the ``examples/python`` folder.