Getting started
***************

.. image:: logo.png
    :width: 80%
    :align: center
    :alt: pybullet_industrial_logo

There are two ways to get started with the library. The first is to use the newest source version from the repository.
The second is to use the latest release version from pip. The source version is the most up-to-date, but it is also the most unstable.
The release version is the most stable, but it is also the least up-to-date.
The release version is recommended for most users, but the source version is recommended for developers.
To learn how to use the library once you have it installed, see the section on "Using the Package" to the left.

Getting started with the release version
========================================
The release version is the most stable version of the library. It is recommended for most users. To install the release version, run the following command:

::

    pip install pybullet_industrial


Getting started with the source version
=======================================
The source version is the most up-to-date version of the library. It is recommended for developers. To install the source version from the repository, run the following commands:

::

    git clone https://github.com/WBK-Robotics/pybullet_industrial
    cd pybullet_industrial
    pip install src/

.. note:: If you are on windows, you may need to use the command ``pip install src\\`` instead. And depending on how you have installed your python environment, you may need to first install ``wheel`` using ``pip install wheel``.


Citing the library
==================

If you use this library in your research, please cite [this paper](https://joss.theoj.org/papers/10.21105/joss.05174#).