Source

ars / INSTALL.txt

INSTALL

(If your OS is Ubuntu, follow the instructions in "ARS installation - Ubuntu.txt", for an easier process that deals with requirements too)

To install the software (only the "ars" package is part of the installation; docs, tests and demos are not), you need to:

1) check & install the requirements listed in README.
2) open a command window, with the current directoy set to the project main directory
3) execute the (included) standard python setup script (you may need administrator privileges):
	python setup.py install

----------------------------------------
TEST INSTALLATION
Start the Python interpreter (with the command "python") and execute this statement:
	import ars

If no errors appear, you are all set.
You may explore the contents by entering "help(ars)".
To exit the interpreter, use "quit()".

----------------------------------------
RUN DEMO
To run a demo, execute any file in the "bin" subfolder, such as:
	python bin/FallingBall.py
	python bin/IROS/example4_sinusoidal_terrain.py

----------------------------------------
BUILD DOCUMENTATION

For epydoc, see ./docs/epydoc
For sphinx, see ./docs/sphinx