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

pylayerstates is currently hosted on PyPI. It required python >= 3.8.

You can simply install pylayerstates from PyPI with the following command:

.. code:: shell

    pip install pylayerstates

You can also install with the newest version through GitHub:

.. code:: shell

    pip install -U git+https://github.com/hansbug/pylayerstates@main

You can check your installation by the following python \
script:

.. literalinclude:: install_check.demo.py
    :language: python
    :linenos:

The output should be like below, which means your installation \
is successful.

.. literalinclude:: install_check.demo.py.txt
    :language: text
    :linenos:

pylayerstates is still under development, you can also check out the \
documents in stable version through `https://hansbug.github.io/pylayerstates/main/index.html <https://hansbug.github.io/pylayerstates/main/index.html>`_.