Tutorials

The quickest way to get started with FEASST is to find a tutorial that is closest to what you would like to accomplish. After verifying that you can reproduce the expected result, use the Text Interface documentation to better understand and modify the classes and arguments. In most tutorials, a Python script is used to generate a text file based on input arguments to a formatted string. The generated text file will be easier to understand than the Python script, and the text files can be run directly as /path/to/feasst/build/bin/fst < input.txt. Include the text file when you Contact us with issues.

The following tutorials are also located in the code repository with the same path as the html (e.g., in /path/to/feasst/plugin/[name]/tutorial/).

Basic tutorials:

Build and test models:

Flat-histogram simulations:

Others:

Text file interface

The above tutorials feature the Text Interface of FEASST, which is the recommended interface for most users. The Text Interface comprises the names of many classes and their constructor arguments. Thus, most users will want to search the Text Interface documentation for these classes.

Python and C++ interface

FEASST may also be called directly in Python and C++ as a library. The Python interface with SWIG and C++ Interface are not recommended for most users, and maybe change with minor version.