Introduction

This repository contains the runtime assets for the various application flavors in the Exabyte platform workflow units.

Installation

Javascript

npm install @exabyte-io/application-flavors.js

Repo Organization

Application templates live in assets, with each subdirectory being the name of each application. All files in here are considered to be Jinja2 templates (regardless of the file extension), and so each file has a *.j2.* name as a reminder.

The javascript library source code lives in src/js to make room for other language libraries in the future.

Building, Testing, and Using in Development

With a working NPM environment, do:

 npm install
 npm test

To build the library's source such that you can import it from another project during development, do:

npm run prepublishOnly

Then you can change your importing project's package.json to temporarily include the file path import instead of installing from NPM:

"@exabyte-io/application-flavors.js": "file:/some/path/to/application-flavors",

Remember to revert this line to an NPM version when you're done developing.

Python Integration Tests

We use the built-in unittests module to run our unit tests. They can be run by doing:

cd test/pythonml
python -m unittest

This set of tests is configured using the integration_configuration.yaml file, which contains information for which units are to be present in a test, and the order they're to be run in. It also contains general settings, such as where the test fixtures are located, and which files need to be cleaned up when a test job is complete.

Applications, Models, and Methods

The available models for each application are defined via asset files in the models directory, and methods directory, respectively. The asset files are used to construct a single object whitelisting all models implemented by a given application (filter_trees.js). These asset files are organized in the specific way, whereby the filepath also plays a role in the generation of the model list object:

1. directory - application name
2. filename - application version
3. first level (of the object defined by asset) - application build
4. second level - executable
5. third level - flavor

The property for a given set of application parameters contains a list of filter objects defining the path of the model (path) or a regular expression (regex). These assets can also be reused to define new assets using the !include Yaml tag (defined in code.js), which also supports accessing properties and array elements (see example below).

# build asset based on another asset
Default:
  pw.x:
    # reuse all pw_scf filters from version 5.2.1
    pw_scf: !include "models/espresso/5.2.1.yml#/Default/pw.x/pw_scf"

    # define filters for pw_scf_bands_hse flavor in-place
    pw_scf_bands_hse:
      - path: /pb/qm/dft/ksdft/hybrid?functional=hse
        isRemoved: true
      - path: /pb/qm/dft/ksdft/hybrid?functional=hse06