Getting HelpΒΆ

\longrightarrow Next quick start chapter: Obtaining/Modifying the Source Code


OSMPS was originally released open-source on Source Forge in March 2014. The previous link should direct you to the online repository which includes a discussion page outlining questions and errors encountered while developing MPS, in addition to the full repository where all the source code can be obtained, as well as to files where the latest release may be downloaded. OSMPS has been beta-tested within the Carr Theoretical Physics Group; however, if you should find any bugs or areas to improve the code, please document the issues and contact the developers through the Source Forge repository.

While installing OSMPS, there are a number of resources outlined starting in Section Choosing Operating System (OS) regarding choosing the appropriate operating system, installing the necessary dependencies, and building the OSMPS software for use. External resources have been attributed to each set of installation instructions, as well as common errors that may arise when installing the necessary dependencies.

There are a set of example simulations that can be found in the OSMPS repository. Following the full OSMPS manual you get to detailed and commented examples of simulations that are included in the repository.

The docstring of each object in the Python libraries can be accessed by using the help function in the Python interpreter, e.g.

>> import MPSPyLib as mps
>> help(mps.runMPS)
>> Help on function runMPS in module MPSPyLib.tools:
>>
>> runMPS(infileList, RunDir=None, Debug=False, customAppl=None)
>>     Run the MPS application with the given list of input files.
>>
>>     **Arguments**
>>
>> ...

In addition to this option to obtain the syntax, usage, and optional arguments of the MPSPyLib functions, you can find the information in Documentation of classes and functions. Additionally, any question can be posted to the dicussion page, and can be answered in one of the forums.


\longrightarrow Next quick start chapter: Obtaining/Modifying the Source Code