@cosmotech/api-ts 3.3.4 → 4.2.5-onprem

package/docs/RunStatusNode.md

@@ -0,0 +1,43 @@
+# RunStatusNode
+
+status of a Run Node
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the node id | [optional] [default to undefined]
+**name** | **string** | the node unique name | [optional] [default to undefined]
+**containerName** | **string** | the Run container name | [optional] [default to undefined]
+**outboundNodes** | **Array<string>** | the list of outbound nodes | [optional] [readonly] [default to undefined]
+**resourcesDuration** | [**RunResourceRequested**](RunResourceRequested.md) |  | [optional] [default to undefined]
+**estimatedDuration** | **number** | estimatedDuration in seconds | [optional] [default to undefined]
+**hostNodeName** | **string** | HostNodeName name of the Kubernetes node on which the Pod is running, if applicable | [optional] [default to undefined]
+**message** | **string** | a human readable message indicating details about why the node is in this condition | [optional] [default to undefined]
+**phase** | **string** | high-level summary of where the node is in its lifecycle | [optional] [default to undefined]
+**progress** | **string** | progress to completion | [optional] [default to undefined]
+**startTime** | **string** | the node start time | [optional] [default to undefined]
+**endTime** | **string** | the node end time | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunStatusNode } from '@cosmotech/api-ts';
+
+const instance: RunStatusNode = {
+    id,
+    name,
+    containerName,
+    outboundNodes,
+    resourcesDuration,
+    estimatedDuration,
+    hostNodeName,
+    message,
+    phase,
+    progress,
+    startTime,
+    endTime,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplate.md

@@ -0,0 +1,87 @@
+# RunTemplate
+
+a Solution Run Template
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Solution Run Template id | [default to undefined]
+**name** | **string** | the Run Template name | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | a translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**description** | **string** | the Run Template description | [optional] [default to undefined]
+**csmSimulation** | **string** | the Cosmo Tech simulation name. This information is send to the Engine. Mandatory information if no Engine is defined | [optional] [default to undefined]
+**tags** | **Array<string>** | the list of Run Template tags | [optional] [default to undefined]
+**computeSize** | **string** | the compute size needed for this Run Template. Standard sizes are basic and highcpu. Default is basic | [optional] [default to undefined]
+**runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) |  | [optional] [default to undefined]
+**noDataIngestionState** | **boolean** | set to true if the run template does not want to check data ingestion state (no probes or not control plane) | [optional] [default to undefined]
+**fetchDatasets** | **boolean** | whether or not the fetch dataset step is done | [optional] [default to undefined]
+**scenarioDataDownloadTransform** | **boolean** | whether or not the scenario data download transform step step is done | [optional] [default to undefined]
+**fetchScenarioParameters** | **boolean** | whether or not the fetch parameters step is done | [optional] [default to undefined]
+**applyParameters** | **boolean** | whether or not the apply parameter step is done | [optional] [default to undefined]
+**validateData** | **boolean** | whether or not the validate step is done | [optional] [default to undefined]
+**sendDatasetsToDataWarehouse** | **boolean** | whether or not the Datasets values are send to the DataWarehouse prior to Simulation Run. If not set follow the Workspace setting | [optional] [default to undefined]
+**sendInputParametersToDataWarehouse** | **boolean** | whether or not the input parameters values are send to the DataWarehouse prior to Simulation Run. If not set follow the Workspace setting | [optional] [default to undefined]
+**preRun** | **boolean** | whether or not the pre-run step is done | [optional] [default to undefined]
+**run** | **boolean** | whether or not the run step is done | [optional] [default to undefined]
+**postRun** | **boolean** | whether or not the post-run step is done | [optional] [default to undefined]
+**parametersJson** | **boolean** | whether or not to store the scenario parameters in json instead of csv | [optional] [default to undefined]
+**parametersHandlerSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) |  | [optional] [default to undefined]
+**datasetValidatorSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) |  | [optional] [default to undefined]
+**preRunSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) |  | [optional] [default to undefined]
+**runSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) |  | [optional] [default to undefined]
+**postRunSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) |  | [optional] [default to undefined]
+**scenariodataTransformSource** | [**RunTemplateStepSource**](RunTemplateStepSource.md) |  | [optional] [default to undefined]
+**parameterGroups** | **Array<string>** | the ordered list of parameters groups for the Run Template | [optional] [default to undefined]
+**stackSteps** | **boolean** | whether or not to stack adjacent scenario run steps in one container run which will chain steps | [optional] [default to undefined]
+**gitRepositoryUrl** | **string** | an optional URL to the git repository | [optional] [default to undefined]
+**gitBranchName** | **string** | an optional git branch name | [optional] [default to undefined]
+**runTemplateSourceDir** | **string** | an optional directory where to find the run template source | [optional] [default to undefined]
+**orchestratorType** | [**RunTemplateOrchestrator**](RunTemplateOrchestrator.md) |  | [optional] [default to undefined]
+**executionTimeout** | **number** | an optional duration in seconds in which a workflow is allowed to run | [optional] [default to undefined]
+**deleteHistoricalData** | [**DeleteHistoricalData**](DeleteHistoricalData.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplate } from '@cosmotech/api-ts';
+
+const instance: RunTemplate = {
+    id,
+    name,
+    labels,
+    description,
+    csmSimulation,
+    tags,
+    computeSize,
+    runSizing,
+    noDataIngestionState,
+    fetchDatasets,
+    scenarioDataDownloadTransform,
+    fetchScenarioParameters,
+    applyParameters,
+    validateData,
+    sendDatasetsToDataWarehouse,
+    sendInputParametersToDataWarehouse,
+    preRun,
+    run,
+    postRun,
+    parametersJson,
+    parametersHandlerSource,
+    datasetValidatorSource,
+    preRunSource,
+    runSource,
+    postRunSource,
+    scenariodataTransformSource,
+    parameterGroups,
+    stackSteps,
+    gitRepositoryUrl,
+    gitBranchName,
+    runTemplateSourceDir,
+    orchestratorType,
+    executionTimeout,
+    deleteHistoricalData,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateCreateRequest.md

@@ -0,0 +1,37 @@
+# RunTemplateCreateRequest
+
+A Solution Run Template Create Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The Solution Run Template id | [default to undefined]
+**name** | **string** | The Run Template name | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**description** | **string** | The Run Template description | [optional] [default to undefined]
+**tags** | **Array<string>** | The list of Run Template tags | [optional] [default to undefined]
+**computeSize** | **string** | The compute size needed for this Run Template | [optional] [default to undefined]
+**runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) |  | [optional] [default to undefined]
+**parameterGroups** | **Array<string>** | The ordered list of parameters groups for the Run Template | [optional] [default to undefined]
+**executionTimeout** | **number** | An optional duration in seconds in which a workflow is allowed to run | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateCreateRequest } from '@cosmotech/api-ts';
+
+const instance: RunTemplateCreateRequest = {
+    id,
+    name,
+    labels,
+    description,
+    tags,
+    computeSize,
+    runSizing,
+    parameterGroups,
+    executionTimeout,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateOrchestrator.md

@@ -0,0 +1,11 @@
+# RunTemplateOrchestrator
+
+the Orchestrator to use for the Run Template
+
+## Enum
+
+* `ArgoWorkflow` (value: `'argoWorkflow'`)
+
+* `CsmOrc` (value: `'csmOrc'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameter.md

@@ -0,0 +1,35 @@
+# RunTemplateParameter
+
+a Run Template Parameter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Parameter id | [default to undefined]
+**labels** | **{ [key: string]: string; }** | a translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**varType** | **string** | the variable type for the parameter. Basic types or special type %DATASETID% | [optional] [default to undefined]
+**defaultValue** | **string** | the default value for this parameter | [optional] [default to undefined]
+**minValue** | **string** | the minimum value for this parameter | [optional] [default to undefined]
+**maxValue** | **string** | the maximum value for this parameter | [optional] [default to undefined]
+**regexValidation** | **string** | a regex to validate the value | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** | freeform options | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameter } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameter = {
+    id,
+    labels,
+    varType,
+    defaultValue,
+    minValue,
+    maxValue,
+    regexValidation,
+    _options,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameterCreateRequest.md

@@ -0,0 +1,35 @@
+# RunTemplateParameterCreateRequest
+
+A Run Template Parameter for creation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The Parameter id | [default to undefined]
+**description** | **string** | The parameter description | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**varType** | **string** | The variable type for the parameter. Basic types or special type %DATASETID% | [default to undefined]
+**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
+**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
+**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameterCreateRequest } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameterCreateRequest = {
+    id,
+    description,
+    labels,
+    varType,
+    defaultValue,
+    minValue,
+    maxValue,
+    additionalData,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameterGroup.md

@@ -0,0 +1,31 @@
+# RunTemplateParameterGroup
+
+a Parameter Group for a Run Template
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Parameter Group id | [default to undefined]
+**labels** | **{ [key: string]: string; }** | a translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**isTable** | **boolean** | does the group define a table | [optional] [default to undefined]
+**_options** | **{ [key: string]: any; }** | freeform options | [optional] [default to undefined]
+**parentId** | **string** | the Run Template Group parent Id | [optional] [default to undefined]
+**parameters** | **Array<string>** | an ordered list of Run Template Parameters | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameterGroup } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameterGroup = {
+    id,
+    labels,
+    isTable,
+    _options,
+    parentId,
+    parameters,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameterGroupCreateRequest.md

@@ -0,0 +1,29 @@
+# RunTemplateParameterGroupCreateRequest
+
+A Parameter Group Create Request for a Run Template
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The Parameter Group id | [default to undefined]
+**description** | **string** | A description of the parameter group | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameterGroupCreateRequest } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameterGroupCreateRequest = {
+    id,
+    description,
+    labels,
+    additionalData,
+    parameters,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameterGroupUpdateRequest.md

@@ -0,0 +1,27 @@
+# RunTemplateParameterGroupUpdateRequest
+
+A Parameter Group Update Request for a Run Template
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** | A description of the parameter group | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+**parameters** | **Array<string>** | An ordered list of Run Template Parameters | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameterGroupUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameterGroupUpdateRequest = {
+    description,
+    labels,
+    additionalData,
+    parameters,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameterUpdateRequest.md

@@ -0,0 +1,33 @@
+# RunTemplateParameterUpdateRequest
+
+A Run Template Parameter for update parameter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** | The parameter description | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**varType** | **string** | The variable type for the parameter. Basic types or special type %DATASETID% | [optional] [default to undefined]
+**defaultValue** | **string** | The default value for this parameter | [optional] [default to undefined]
+**minValue** | **string** | The minimum value for this parameter | [optional] [default to undefined]
+**maxValue** | **string** | The maximum value for this parameter | [optional] [default to undefined]
+**additionalData** | **{ [key: string]: any; }** | Free form additional data | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameterUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameterUpdateRequest = {
+    description,
+    labels,
+    varType,
+    defaultValue,
+    minValue,
+    maxValue,
+    additionalData,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateParameterValue.md

@@ -0,0 +1,25 @@
+# RunTemplateParameterValue
+
+the value of Analysis parameter for a Runner for this Run
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameterId** | **string** | the parameter Id | [default to undefined]
+**varType** | **string** | the parameter value type | [optional] [readonly] [default to undefined]
+**value** | **string** | the parameter value | [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateParameterValue } from '@cosmotech/api-ts';
+
+const instance: RunTemplateParameterValue = {
+    parameterId,
+    varType,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateResourceSizing.md

@@ -0,0 +1,23 @@
+# RunTemplateResourceSizing
+
+a description object for resource requests and limits (default same configuration as basic sizing)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**ResourceSizeInfo**](ResourceSizeInfo.md) |  | [default to undefined]
+**limits** | [**ResourceSizeInfo**](ResourceSizeInfo.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateResourceSizing } from '@cosmotech/api-ts';
+
+const instance: RunTemplateResourceSizing = {
+    requests,
+    limits,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateStepSource.md

@@ -0,0 +1,15 @@
+# RunTemplateStepSource
+
+the source local, cloud or git repository
+
+## Enum
+
+* `Cloud` (value: `'cloud'`)
+
+* `Git` (value: `'git'`)
+
+* `Local` (value: `'local'`)
+
+* `Platform` (value: `'platform'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunTemplateUpdateRequest.md

@@ -0,0 +1,35 @@
+# RunTemplateUpdateRequest
+
+A Solution Run Template Create Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | The Run Template name | [optional] [default to undefined]
+**labels** | **{ [key: string]: string; }** | A translated label with key as ISO 639-1 code | [optional] [default to undefined]
+**description** | **string** | The Run Template description | [optional] [default to undefined]
+**tags** | **Array<string>** | The list of Run Template tags | [optional] [default to undefined]
+**computeSize** | **string** | The compute size needed for this Run Template | [optional] [default to undefined]
+**runSizing** | [**RunTemplateResourceSizing**](RunTemplateResourceSizing.md) |  | [optional] [default to undefined]
+**parameterGroups** | **Array<string>** | The ordered list of parameters groups for the Run Template | [optional] [default to undefined]
+**executionTimeout** | **number** | An optional duration in seconds in which a workflow is allowed to run | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { RunTemplateUpdateRequest } from '@cosmotech/api-ts';
+
+const instance: RunTemplateUpdateRequest = {
+    name,
+    labels,
+    description,
+    tags,
+    computeSize,
+    runSizing,
+    parameterGroups,
+    executionTimeout,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Runner.md

@@ -0,0 +1,63 @@
+# Runner
+
+a Runner with base information
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the Runner unique identifier | [optional] [readonly] [default to undefined]
+**name** | **string** | the Runner name | [optional] [default to undefined]
+**description** | **string** | the Runner description | [optional] [default to undefined]
+**tags** | **Array<string>** | the list of tags | [optional] [default to undefined]
+**parentId** | **string** | the Runner parent id | [optional] [default to undefined]
+**ownerId** | **string** | the user id which own this Runner | [optional] [readonly] [default to undefined]
+**rootId** | **string** | the runner root id | [optional] [readonly] [default to undefined]
+**solutionId** | **string** | the Solution Id associated with this Runner | [optional] [readonly] [default to undefined]
+**runTemplateId** | **string** | the Solution Run Template Id associated with this Runner | [optional] [default to undefined]
+**organizationId** | **string** | the associated Organization Id | [optional] [readonly] [default to undefined]
+**workspaceId** | **string** | the associated Workspace Id | [optional] [readonly] [default to undefined]
+**creationDate** | **number** | the Runner creation date | [optional] [readonly] [default to undefined]
+**lastUpdate** | **number** | the last time a Runner was updated | [optional] [readonly] [default to undefined]
+**ownerName** | **string** | the name of the owner | [optional] [readonly] [default to undefined]
+**solutionName** | **string** | the Solution name | [optional] [readonly] [default to undefined]
+**runTemplateName** | **string** | the Solution Run Template name associated with this Runner | [optional] [readonly] [default to undefined]
+**datasetList** | **Array<string>** | the list of Dataset Id associated to this Runner Run Template | [optional] [default to undefined]
+**runSizing** | [**RunnerResourceSizing**](RunnerResourceSizing.md) |  | [optional] [default to undefined]
+**parametersValues** | [**Array<RunnerRunTemplateParameterValue>**](RunnerRunTemplateParameterValue.md) | the list of Solution Run Template parameters values | [optional] [default to undefined]
+**lastRunId** | **string** | last run id from current runner | [optional] [default to undefined]
+**validationStatus** | [**RunnerValidationStatus**](RunnerValidationStatus.md) |  | [optional] [default to undefined]
+**security** | [**RunnerSecurity**](RunnerSecurity.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Runner } from '@cosmotech/api-ts';
+
+const instance: Runner = {
+    id,
+    name,
+    description,
+    tags,
+    parentId,
+    ownerId,
+    rootId,
+    solutionId,
+    runTemplateId,
+    organizationId,
+    workspaceId,
+    creationDate,
+    lastUpdate,
+    ownerName,
+    solutionName,
+    runTemplateName,
+    datasetList,
+    runSizing,
+    parametersValues,
+    lastRunId,
+    validationStatus,
+    security,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/RunnerAccessControl.md

@@ -0,0 +1,23 @@
+# RunnerAccessControl
+
+a Runner access control item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | the identity id | [default to undefined]
+**role** | **string** | a role | [default to undefined]
+
+## Example
+
+```typescript
+import { RunnerAccessControl } from '@cosmotech/api-ts';
+
+const instance: RunnerAccessControl = {
+    id,
+    role,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)