ars / docs / sphinx / source / index.rst

Autonomous Robot Simulator


This software and its documentation are currently under development so they will be subject to changes. Contributions are welcome!


Welcome! This is the documentation for Autonomous Robot Simulator (ARS) |version|, last updated on |today|.

ARS is written in a marvelous programming language called Python. One of the many features that make it great (and popular) is its documentation. Taking that into consideration, many sections herein were taken from the official Python documentation.

So simple

To create and run your first simulation, a few lines of code are enough! Execute the following script (press key q or e to end the simulation)

from import Program

class FallingBall(Program):

   def create_sim_objects(self):
      # add_sphere's arguments: radius, center, density
      self.sim.add_sphere(0.5, (1, 10, 1), density=1)

sim_program = FallingBall()

Official website

The repository is hosted at BitBucket where you will find the source code and a downloads section. There is an issue tracker too, letting you file bugs and request features or improvements for ARS.

Because we like the Python community and the tools they use, it is registered in PyPI (Python Package Index). Although useful for organizing packages, the main benefit is to be able to install (and upgrade) ARS using the pip program. It takes just 3 words:

pip install ARS

(well, you might have to prepend sudo if you are using Linux and running as a user without the required priveges. Bummer, that's 4 words now...)

For support, check the Google group and join if you want to post a message.



What has happened lately...