Configuration File

The Configuration File defines a Package. It is typically named hxpkg.yaml, and has two sections: the top level package section, which describes the Package itself, and the modules section, which lists and describes the Modules it contains.

Each section has its own set of keys that can be configured.

Package Keys

id: id
name: name
version: 1.0.0
publisher: Publisher of the Package
description: Description of the Package
keywords: []
readme: readme.md
changelog: changelog.md
icon: icon.png
include: include.regex
exclude: exclude.regex
apis:
    solver:
        target: 1.0.0
        min: 0.0.0
    scripting:
        target: 1.0.0
        min: 0.0.0
environment:
    pip_requirements: requirements.txt
    conda_environment: environment.yml
dependencies:
- other.package.id

Table 1. Package Keys

Key	Required?	Remarks
`id`	Required	A unique identifier for the Package. Used as the dependency reference by other Packages. Example: `collieraerospace.core`
`name`	Required	Display name. Example: Collier Aerospace Corp
`version`	Required	A version identifier. Should follow Semantic Versioning. Pre-release flags are allowed. Example: 1.0.0
`publisher`	Required	Who published the Package. Example: Collier Aerospace
`description`	Optional	A description of the Package displayed to users in the Package Manager helping them to decide if the Package is right for them.
`keywords`	Optional	Keywords to help users find your Package in the Package Manager. Example: `['panel', 'beam', 'joint']`
`readme`	Optional	A document describing a Package in greater detail than what would go along with a `description` key. Viewable in the Package Manager. Example: `readme.md`
`changelog`	Optional	Log of changes to the Package over time. We recommend organizing these by version. Example: `changelog.md`
`icon`	Optional	Icon representing the Package. Example: `icon.png`
`dependencies`	Optional	Packages that this Package depends on. Example: `['collieraerospace.core >= 3.0.0']`
`warning`	Optional	A warning about this Package. Example: `[This package is experimental!]`
`include`	Optional	Regex file pattern to specifically include in the Package, even if they are not called out by another Package Key. E. g. images for the readme, additional reference, extra C# libraries, etc. Match against the file path relative to the Package root. Example: `(img/)\|(ext/)`
`exclude`	Optional	Regex file pattern to specifically exclude from the Package. This overrides files included by the `include` pattern. Match against the file path relative to the Package root. Example: `(bin/)\|(x64/)`
`apis.solver.target`	Optional	Target Solver API this Package is designed for. The Package is applicable for versions >= target and <= the next major (breaking) Solver API. Example: 1.0.0
`apis.solver.min`	Optional	The minimum Solver API this Package is compatible with. The Package is applicable for versions >= min. Example: 1.0.0
`apis.scripting.target`	Optional	Target Scripting API this Package is designed for. The Package is applicable for versions >= target and <= the next major (breaking) Scripting API. Example: 1.0.0
`apis.scripting.min`	Optional	The minimum Scripting API this Package is compatible with. The Package is applicable for versions >= min. Example: 1.0.0
`environment.pip_requirements`	Optional	The file containing Python pip requirements for this Package as printed by `pip freeze`. Currently unused by HyperX. Example: `requirements.txt`
`environment.conda_environment`	Optional	The file containing the Python conda environment for this Package as printed by `conda env export`. Currently unused by HyperX. Example: `environment.yml`

Module Keys

modules:
    type: criterion
    id: criterion.id
    name: Name
    version: 1.0.0
    description: Description of the Module
    main: Criterion.dll
    docs: CriterionHme.pdf
    changelog: changelog.md
    icon: icon.png

Table 2. Module Keys

Key	Required?	Remarks
`type`	Required	What type of Module this is. Describes what type of capability it provides, and what sort of interface the main file fulfills. Types: `criterion` `script`
`id`	Required	Uniquely identifies this Module within the Package.
`name`	Required	Display name. Example: `buckling.rr3`
`version`	Required	A version identifier. Should follow Semantic Versioning. Example: 1.0.0
`description`	Optional	A short description of this Module.
`main`	Required	The main entry point for this Module. Example: `RR3Buckling.dll`
`docs`	Optional	Documentation for this Module. Can be any file format. Example: `RR3BucklingHME.pdf`
`changelog`	Optional	File describing how this module has changed over time. Example: `CHANGELOG.md`
`icon`	Optional	Icon representing this module. Example: `icon.png`

Criterion Module Keys

modules:
    type: criterion
    # ...
    criterion:
        class: ModuleImplementation

Table 3. Criterion Module Keys

Key

Required?

Remarks

criterion.class

Optional

The name of the class in the .dll that implements ICriterionModule (if there are multiple).

See Template Package: collieraerospace.criterion.sample.multimod.

Example: StrengthModule

Script Module Keys

modules:
    type: script
    # ...
    script:
        folder: [Entities, Zones]

Table 4. Script Module Keys

Key

Required?

Remarks

script.folder

Optional

Describes organizational structure for this Script within the Package.

Example: [Entities, Zones]

Package Keys

Module Keys

Criterion Module Keys

Script Module Keys

Recently Viewed

Didn’t find what you’re looking for?

Didn’t find what you’re looking for?