Code Templating Generators

Because the number and type of keywords provided in AFLOW is subject to change, we opted for a dynamic generation of the AFLOW Database Keywords and AFLOW Database Entries. The generators make a request to the schema introspection of AFLOW API to determine what’s available and how it is documented. This provides data to generate custom modules for the aflow python library.

Documentation and format builders for the latest AFLUX specification. Since AFLUX is in constant flux, we generate the documentation and keyword lists dynamically at development time whenever a new version is released. This happens by parsing the HTML page that lists all available keywords and then querying the help feature of the AFLOW API for additional information. This is then used to generate the API documentation automatically.

aflow.generators.keywords(root=None)[source]

Generates a python module file for the Entry that has documented methods for lazy loading of properties from AFLOW database.

Parameters:root (str) – path in which to generate the module files.