boaviztapi-sdk

🎯 Retrieving the impacts of digital elements.

This is a quick demo, to see full documentation click here

Features

Bellow a list of all available features.

👄 Verbose

Verbose is an HTTP parameter. If set at true :

• Shows the impacts of each component
• Shows the value used for each attribute

\"attribute\": {\"value\": \"value\", \"unit\": \"unit\", \"status\": \"Status\", \"source\": \"Source\", \"min\":\"min\", \"max\":\"max\", \"significant_figures\":\"significant_figures\"}

🔨 Embedded

• Embedded impacts are the impacts occurring during raw material extraction, manufacture, distribution and end of life
• When end of life is not taken into account, we specified it in the warnings

🔌 Usage

Usage impacts are assessed by multiplying :

• a duration

• an impact factor

• an electrical consumption

⏲ Duration

Usage impacts can be given as a router parameter, in hours.

If no duration is given, the impact is assess for the all life duration of the asset.

✖️ Impact factors

• Impact factors can be given : \"usage\":{\"elec_factors\":{[criteria]: 0.38}}

• Impact factors can be retrieved from : \"usage\":{\"usage_location\": \"FRA\"}.

• See the list of locations : /v1/utils/country_code*

⚡ Electrical consumption

⏺️ Given

• Electrical consumption can be given for one hour (average) \"usage\":{\"avg_power\": 1}.

📈 Modeled

• Electrical consumption can be retrieved from consumption profile using usage:{time_workload: 50}.

📋 Archetype

• In some cases, default electrical consumption can be taken from the archetype

🔃 Auto-complete & 📋 Archetype

The API will complete the missing attributes in a request with a completion function or with values taken from the archetype specified in the route parameter.

⏬ Allocation

• Usage impacts are assessed on the duration given in route parameter
• Embedded impacts are allocated linearly on the duration given in parameter embedded_impact = impact * (duration/life_duration)

If no duration is given, the life_duration (`hours_life_time) of the asset is used.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 2.4.1
• Package version: 2.4.1
• Generator version: 7.25.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/boavizta/boaviztapi.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/boavizta/boaviztapi.git)

Then import the package:

import boaviztapi_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import boaviztapi_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import boaviztapi_sdk
from boaviztapi_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = boaviztapi_sdk.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with boaviztapi_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = boaviztapi_sdk.CloudApi(api_client)
    provider = 'aws' # str |  (optional) (default to 'aws')
    instance_type = 'a1.4xlarge' # str |  (optional) (default to 'a1.4xlarge')

    try:
        # Get Archetype Config
        api_response = api_instance.get_archetype_config_v1_cloud_instance_instance_config_get(provider=provider, instance_type=instance_type)
        print("The response of CloudApi->get_archetype_config_v1_cloud_instance_instance_config_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CloudApi->get_archetype_config_v1_cloud_instance_instance_config_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• Box
• CPU
• Case
• Cloud
• ConfigurationServer
• ConsumptionProfileCPU
• Desktop
• Disk
• ElecFactors
• ExternalHDD
• ExternalSSD
• FunctionalBlock
• GPU
• HTTPValidationError
• IoT
• Laptop
• LocationInner
• ModelServer
• Monitor
• Motherboard
• PowerSupply
• RAM
• Server
• Smartphone
• Tablet
• Television
• TimeWorkload
• Usage
• UsageCloud
• UsageServer
• UsbStick
• ValidationError
• VrController
• VrHeadset
• WorkloadPower
• WorkloadTime

Documentation For Authorization

Endpoints do not require authorization.

Author