Getting Started
===============

Installation
------------

Currently, SwirlsPy supports Linux 64-bit only. If you would like to try it on
Windows or Mac, we suggest that you intsall 
`Virtual Box <https://www.virtualbox.org/>`_ and 
`Ubuntu Desktop LTS <https://www.ubuntu.com/>`_. It has been reported that 
SwirlsPy also works on 
`WSL for Win10 <https://docs.microsoft.com/en-us/windows/wsl/install-win10>`_.

If your system does not have Conda installed, you may wish to follow 
`this instruction <https://conda.io/docs/user-guide/install/index.html>`_
to install it first.

SwirlsPy is now distributed as `Conda <https://conda.io/>`_ Package, and can be 
installed with the following one-line command::

    conda install -c https://username:password@conda.com-swirls.org -c conda-forge swirlspy

The username/password is provided in the file
`README.rst <https://com-swirls.org/com-swirls/swirlspy/blob/master/README.rst>`_,
available from the front page upon completion of registration or sign-in of the
GitLab repository.

Please feel free to `contact us <https://docs.com-swirls.org/contact-us.html/>`_ 
if you have any question.