Command

class Command(madx, data)[source]

Bases: _MutableMapping

Raw python interface to issue and view MAD-X commands. Usage example:

>>> madx.command.twiss(sequence='LEBT')
>>> madx.command.title('A meaningful phrase')
>>> madx.command.twiss.betx
0.0

Attributes Summary

cmdpar

defs

Methods Summary

__call__(**kwargs)

Perform a single MAD-X command.

clear()

clone(**kwargs)

Clone this command, assign the given name. This corresponds to the colon syntax in MAD-X, e.g.::.

get(k[,d])

items()

keys()

pop(k[,d])

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem()

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[,d])

update([E, ]**F)

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values()

Attributes Documentation

cmdpar
defs

Methods Documentation

__call__(**kwargs)[source]

Perform a single MAD-X command.

clear() None.  Remove all items from D.
clone(**kwargs)[source]

Clone this command, assign the given name. This corresponds to the colon syntax in MAD-X, e.g.:

madx.command.quadrupole.clone('qp', at=2, l=1)

translates to the MAD-X command:

qp: quadrupole, at=2, l=1;
get(k[, d]) D[k] if k in D, else d.  d defaults to None.
items() a set-like object providing a view on D's items
keys() a set-like object providing a view on D's keys
pop(k[, d]) v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() (k, v), remove and return some (key, value) pair

as a 2-tuple; but raise KeyError if D is empty.

setdefault(k[, d]) D.get(k,d), also set D[k]=d if k not in D
update([E, ]**F) None.  Update D from mapping/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() an object providing a view on D's values