ScatterSim:API - Revision history

JulienLhermitte at 13:49, 20 July 2017

2017-07-20T13:49:20Z

JulienLhermitte at 20:29, 10 July 2017

2017-07-10T20:29:20Z

JulienLhermitte: Created page with "== ScatterSim API == This page documents the general API for the ScatterSim code. === Structure === In general, the objects in the ScatterSim code used to generate simulation..."

2017-07-10T20:29:09Z

Created page with "== ScatterSim API == This page documents the general API for the ScatterSim code. === Structure === In general, the objects in the ScatterSim code used to generate simulation..."

New page

== ScatterSim API ==
This page documents the general API for the ScatterSim code.

=== Structure ===
In general, the objects in the ScatterSim code used to generate simulations are either:

# NanoObject : the base object
# CompositeNanoObject : an arrangement of NanoObject objects
# Lattice objects : NanoObjects that are assembled into a lattice.

==== NanoObjects or Composite NanoObjects ====
Each of these elements is initialized by calling their initialization class.
To initialize a NanoObject or CompositeNanoObject, potential arguments must be supplied:
<source lang='python'>
from ScatterSim.NanoObjects import SphereNanoObject
pargs = {"radius" : 10}
sphere = SphereNanoObject(pargs=pargs)
</source>

where pargs is a dictionary containing the parameters that describe the system. Here, a SphereNanoObject only requires a radius as a parameter. Other more complex objects, like CylinderNanoObject may require more parameters (such as height in this case).

==== Creating a new CompositeNanoObject ====
Sometimes the objects available are not enough and a more complex objects is needed.
Objects may be compounded into more complex NanoObject objects by creating a new CompositeNanoObject.

=== Vectors ===

← Older revision		Revision as of 13:49, 20 July 2017
Line 28:		Line 28:


		+	=== Vectors ===
		+	Rotations

−	~~=== Vectors ===~~	+	Any object's canonical rotation is described in its docstring. From there, it is possible to re-orient it.
		+
		+
		+	The orientation is defined with the following parameters
		+	* x0, y0, z0 : the z y and z position with respect to the object's internal reference frame
		+	* eta, theta, phi : the Euler angles. THe rotations are defined as follows:
		+
		+	Three-axis rotation:
		+	1. Rotate about +z by eta (counter-clockwise in x-y plane)
		+	2. Tilt by phi with respect to +z (rotation about y-axis,
		+	clockwise in x-z plane) then
		+	3. rotate by theta in-place (rotation about z-axis,
		+	counter-clockwise in x-y plane)

← Older revision		Revision as of 20:29, 10 July 2017
Line 1:		Line 1:
	== ScatterSim API ==		== ScatterSim API ==
		+	(Work in progress)
		+
		+
	This page documents the general API for the ScatterSim code.		This page documents the general API for the ScatterSim code.