Assets

Note

This section of the documentation is auto-generated from the code of the Julia-based core model. Refer to IESopt.jl for any further details (which may require some familiarity with Julia).

If you spot incorrect math-mode rendering, or similar issues, please file an issue, since rendering documentation from Julia to Python is not the easiest task.

Overview

Assets

Assets module for IESopt.jl, containing path handling (relocatable) for assets: addons, examples, templates.

API Reference

Types

Macros

Functions

get_path

get_path(asset_type::String)

Get the path to the asset type folder. Currently supports: “addons”, “examples”, “templates”.

Arguments

  • asset_type::String: The asset type.

Returns

  • RelocatableFolders.Path: The path to the asset folder, already using normpath. Path implements an automatic conversion to String.

Example

Assets.get_path("templates")

get_path(asset_type::String, asset_name::String)

Get the path to the asset file, specified by the asset type and asset name. Currently supports the following types: “addons”, “examples”, “templates”.

Arguments

  • asset_type::String: The asset type.

  • asset_name::String: The asset name.

Returns

  • RelocatableFolders.Path: The path to the asset file, already using normpath. Path implements an automatic conversion to String.

Example

Assets.get_path("examples", "08_basic_investment.iesopt.yaml")