diff --git a/docs/icsneopy/can_getting_started.rst b/docs/icsneopy/can_getting_started.rst index fcad421..6994670 100644 --- a/docs/icsneopy/can_getting_started.rst +++ b/docs/icsneopy/can_getting_started.rst @@ -6,7 +6,7 @@ Prerequisites ============= - Python 3.8 or higher -- icsneopy library installed +- icsneopy installed (see :doc:`installation`) - CAN hardware device connected :download:`Download complete example <../../examples/python/can/can_complete_example.py>` diff --git a/docs/icsneopy/ethernet_getting_started.rst b/docs/icsneopy/ethernet_getting_started.rst index 8cb116f..d5575ac 100644 --- a/docs/icsneopy/ethernet_getting_started.rst +++ b/docs/icsneopy/ethernet_getting_started.rst @@ -8,7 +8,7 @@ Prerequisites ============= - Python 3.8 or higher -- icsneopy library installed +- icsneopy installed (see :doc:`installation`) - Intrepid Control Systems Device :download:`Download complete example <../../examples/python/ethernet/ethernet_complete_example.py>` diff --git a/docs/icsneopy/flexray_getting_started.rst b/docs/icsneopy/flexray_getting_started.rst index d6e4bfe..6ebc449 100644 --- a/docs/icsneopy/flexray_getting_started.rst +++ b/docs/icsneopy/flexray_getting_started.rst @@ -5,7 +5,7 @@ FlexRay Getting Started Prerequisites ============= -- icsneopy library installed +- icsneopy installed (see :doc:`installation`) - FlexRay hardware device connected (e.g., Fire3 Flexray) - Proper FlexRay bus termination (100Ω on each channel end) diff --git a/docs/icsneopy/index.rst b/docs/icsneopy/index.rst index 15f7bf3..d06a65f 100644 --- a/docs/icsneopy/index.rst +++ b/docs/icsneopy/index.rst @@ -5,6 +5,7 @@ icsneopy .. toctree:: :maxdepth: 2 + installation can_getting_started ethernet_getting_started flexray_getting_started diff --git a/docs/icsneopy/installation.rst b/docs/icsneopy/installation.rst new file mode 100644 index 0000000..eef0f22 --- /dev/null +++ b/docs/icsneopy/installation.rst @@ -0,0 +1,38 @@ +============ +Installation +============ + +icsneopy is available on PyPI at https://pypi.org/project/icsneopy/ and can be installed with pip: + +.. code-block:: bash + + pip install icsneopy + +Pre-release +=========== + +For the latest features, install with the ``--pre`` flag to include pre-release versions: + +.. code-block:: bash + + pip install --pre icsneopy + +Upgrading +========= + +To upgrade an existing installation: + +.. code-block:: bash + + pip install --pre --upgrade icsneopy + +Linux udev Rules +================ + +Linux users may want to install the included udev rules to run icsneopy-based +applications without root. The rules file can be found in the libicsneo source +repository at https://github.com/intrepidcs/libicsneo/. + +.. code-block:: bash + + sudo cp 99-intrepidcs.rules /etc/udev/rules.d/