Commits

German Larrain committed 76b0a8a

documentation: added .txt reference files to 'docs' directory

Comments (0)

Files changed (4)

docs/Frame of reference.txt

+http://en.wikipedia.org/wiki/Kinematics#Trajectories_of_points_in_a_moving_body
+http://en.wikipedia.org/wiki/Frame_of_reference#Non-inertial_frames
+http://en.wikipedia.org/wiki/Rotating_reference_frame#Relating_rotating_frames_to_stationary_frames
+
+
+http://en.wikipedia.org/wiki/Frame_of_reference
+http://en.wikipedia.org/wiki/Inertial_frame_of_reference
+http://en.wikipedia.org/wiki/Rigid_body_dynamics
+http://en.wikipedia.org/wiki/Newton-Euler_equations
+http://en.wikipedia.org/wiki/Transformation_matrix
+http://en.wikipedia.org/wiki/Homogeneous_coordinates
+
+
+http://en.wikipedia.org/wiki/Kinematics#Relative_velocity
+http://en.wikipedia.org/wiki/Relative_velocity

docs/VTK Installation from source - Linux.txt

+extract vtk-5.4.2.tar.gz in "~/VTK-5.4.2"
+
+$ mkdir VTK-5.4.2-build
+$ cd VTK-5.4.2-build/
+$ cmake ../VTK-5.4.2
+
+open up CMakeCache.txt in your editor, find the following lines and make sure they are changed to these settings:
+	VTK_WRAP_PYTHON:BOOL=ON
+	BUILD_SHARED_LIBS:BOOL=ON
+
+$ cmake ../VTK-5.4.2
+
+This time you'll probably get some error messages about TCL. In CMakeCache.txt make sure the following line is set:
+	VTK_USE_TK:BOOL=OFF
+
+$ cmake ../VTK-5.4.2
+$ make
+$ make install
+
+$ export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/usr/local/lib/vtk-5.4
+$ cd ~/ARS/bin
+$ python FallingBall.py
+
+sources
+	http://web.eecs.utk.edu/~simmerma/vtk_ubuntu.html
+	http://public.kitware.com/pipermail/vtkusers/2010-April/108447.html

docs/VTK installation - Windows.txt

+To avoid installing VTK by configuring and compiling source (which is complex and takes a long time) manually, do the following:
+
+0) Python must be installed
+
+1) download (thanks to Charl P. Botha) the binaries from
+http://cpbotha.net/2009/08/13/python-2-6-enabled-vtk-5-4-windows-binaries/
+or search for VTK-5-4-2-Py26-VS9sp1-win32-cpbotha.net.zip in
+http://cpbotha.net/software/latest-vtk-windows-binaries/
+(if none of the above is available, try here: http://www.lfd.uci.edu/~gohlke/pythonlibs/)
+
+1.1) Most people may skip this step, but it has been reported that some needed to install "Microsoft Visual C++ 2008 SP1 Redistributable Package (x86)"
+http://www.microsoft.com/download/en/details.aspx?id=5582
+
+2) extract the files to C:\VTK
+
+3) add C:\VTK\bin to your path (PATH environment variable, do not confuse it with PYTHONPATH)
+	(if you don't know how to do it use google or visit http://geekswithblogs.net/renso/archive/2009/10/21/how-to-set-the-windows-path-in-windows-7.aspx)
+
+4) 
+
+
+Edit vtk_sphere_windows.py
+	Change 'base_dir' to the folder where you unzipped VTK. REMEMBER to use a double slash for each regular slash, and to end with a double slash.
+Open a command line window.
+Execute the following:
+	C:\Python26\python.exe path\to\vtk_sphere_windows.py

docs/documentation generation.txt

+german@german-T400:~$ cd Prog/WS/PyCharm/MSc/ars/
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ epydoc -v --config doc/epydoc.cfg ars/
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 20, in ars.exceptions.ArsError
+	|   Warning: Line 23: Improper paragraph indentation.
+	|
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 39, in ars.exceptions.JointError
+	|   Warning: Line 42: Improper paragraph indentation.
+	|
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 31, in ars.exceptions.PhysicsEngineException
+	|   Warning: Line 34: Improper paragraph indentation.
+	|
+	+---------------------------------------------------------------------------------------------------------------------------------------------------------
+	| File /home/german/Prog/WS/PyCharm/MSc/ars/ars/exceptions.py, line 51, in ars.exceptions.PhysicsObjectCreationError
+	|   Warning: Line 54: Improper paragraph indentation.
+	|
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse
+	Usage:
+	  pyreverse [options] <packages>
+
+	  create UML diagrams for classes and modules in <packages>
+
+
+	Options:
+	  -h, --help            show this help message and exit
+	  -f <mode>, --filter-mode=<mode>
+							filter attributes and functions according to
+							<mode>. Correct modes are :
+							'PUB_ONLY' filter all non public attributes
+							[DEFAULT], equivalent to PRIVATE+SPECIAL_A
+							'ALL' no filter                             'SPECIAL'
+							filter Python special functions
+							except constructor                             'OTHER'
+							filter protected and private
+							attributes [current: PUB_ONLY]
+	  -c <class>, --class=<class>
+							create a class diagram with all classes related to
+							<class>; this uses by default the options -ASmy
+							[current: none]
+	  -a <ancestor>, --show-ancestors=<ancestor>
+							show <ancestor> generations of ancestor classes not in
+							<projects>
+	  -A, --all-ancestors   show all ancestors off all classes in <projects>
+	  -s <ass_level>, --show-associated=<ass_level>
+							show <ass_level> levels of associated classes not in
+							<projects>
+	  -S, --all-associated  show recursively all associated off all associated
+							classes
+	  -b, --show-builtin    include builtin objects in representation of classes
+	  -m [yn], --module-names=[yn]
+							include module name in representation of classes
+	  -k, --only-classnames
+							don't show attributes and methods in the class boxes;
+							this disables -f values
+	  -o <format>, --output=<format>
+							create a *.<format> output file if format available.
+							[current: dot]
+
+	  Astng loader:
+		--ignore=<file>     add <file> (may be a directory) to the black list. It
+							should be a base name, not a path. You may set this
+							option multiple times. [current: CVS]
+		-p <project name>, --project=<project name>
+							set the project name. [current: No Name]
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --all-associated ars
+	parsing ars/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/constants.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph1.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --all-associated ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph1.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --class=Sensor ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+	Traceback (most recent call last):
+	  File "/usr/bin/pyreverse", line 4, in <module>
+		main.Run(sys.argv[1:])
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 126, in __init__
+		PyreverseCommand(args)
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 98, in __init__
+		self.run(args)
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/main.py", line 112, in run
+		diadefs = handler.get_diadefs(project, linker)
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/diadefslib.py", line 226, in get_diadefs
+		diagrams.append(generator.class_diagram(project, klass))
+	  File "/usr/lib/python2.7/dist-packages/pylint/pyreverse/diadefslib.py", line 194, in class_diagram
+		module, klass = klass.rsplit('.', 1)
+	ValueError: need more than 1 value to unpack
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --class=ars.model.robot.sensors.Sensor ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph2.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph3.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore=ars.model.contrib.ragdoll ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph4.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore=ars/model/contrib/ragdoll.py ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse --ignore "ars/model/contrib/ragdoll.py" ars.model
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/simulator/__init__.py...
+	...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ pyreverse ars.model.robot
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/__init__.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/sensors.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/actuators.py...
+	parsing /home/german/Prog/WS/PyCharm/MSc/ars/ars/model/robot/joints.py...
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$ dot -Tps classes_No_Name.dot -o graph5.ps
+
+german@german-T400:~/Prog/WS/PyCharm/MSc/ars$
+
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.