Usage¶
From the command line¶
MAICoS can be used directly from the command line, by typing in a terminal:
maicos <module> <paramaters>
You can get the general help page, or a package-specific page by typing, respectively:
maicos -h
maicos <package> -h
For example, to get the help page for the density_planar
module, type:
maicos density_planar -h
From the Python interpreter¶
MAICoS can be used within the python interpreter. In a python environment,
create an analysis
object by supplying an atom group from MDAnalysis
as well as some (optional) parameters, then use the run
method:
import maicos
ana_obj = maicos.<module>(atomgroup, <paramaters>)
ana_obj.run()
Results are available through the objects results dictionary.