e-footprint builders
e-footprint builders are higher-level functions that allows for the creation of e-footprint objects from fewer parameters than the raw model requires.
Default builders
Devices
from efootprint.builders.hardware.devices_defaults import default_smartphone, default_laptop, default_box, default_screen
Hardware id-e9e707-Default-smartphone
carbon_footprint_fabrication: 30 kilogram
power: 1 watt
lifespan: 3 year
fraction_of_usage_time: 3.6 hour / day
Hardware id-610377-Default-laptop
carbon_footprint_fabrication: 156 kilogram
power: 50 watt
lifespan: 6 year
fraction_of_usage_time: 7.0 hour / day
Hardware id-34e669-Default-box
carbon_footprint_fabrication: 78 kilogram
power: 10 watt
lifespan: 6 year
fraction_of_usage_time: 24.0 hour / day
Hardware id-a4167f-Default-screen
carbon_footprint_fabrication: 222 kilogram
power: 30 watt
lifespan: 6 year
fraction_of_usage_time: 7.0 hour / day
Network
from efootprint.builders.hardware.network_defaults import default_mobile_network, default_wifi_network
Network id-45ffd3-Default-mobile-network
bandwidth_energy_intensity: 0.12 kilowatt_hour / gigabyte
calculated_attributes:
energy_footprint: None
Network id-0f9dfe-Default-wifi-network
bandwidth_energy_intensity: 0.05 kilowatt_hour / gigabyte
calculated_attributes:
energy_footprint: None
Servers
Different server types have same default attributes but their calculated attributes logic will be different.
from efootprint.builders.hardware.servers_defaults import default_autoscaling, default_serverless, default_onpremise
Autoscaling id-08a72d-Default-autoscaling
carbon_footprint_fabrication: 600 kilogram
power: 300 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
server_utilization_rate: 0.9 dimensionless
idle_power: 50 watt
ram: 128 gigabyte
cpu_cores: 24 core
power_usage_effectiveness: 1.2 dimensionless
base_ram_consumption: 0 gigabyte
base_cpu_consumption: 0 core
storage: id-162da1-Default-SSD-storage
calculated_attributes:
hour_by_hour_cpu_need: None
hour_by_hour_ram_need: None
available_ram_per_instance: None
available_cpu_per_instance: None
raw_nb_of_instances: None
nb_of_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
Serverless id-91ec8c-Default-serverless
carbon_footprint_fabrication: 600 kilogram
power: 300 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
server_utilization_rate: 0.9 dimensionless
idle_power: 50 watt
ram: 128 gigabyte
cpu_cores: 24 core
power_usage_effectiveness: 1.2 dimensionless
base_ram_consumption: 0 gigabyte
base_cpu_consumption: 0 core
storage: id-1e56f8-Default-SSD-storage
calculated_attributes:
hour_by_hour_cpu_need: None
hour_by_hour_ram_need: None
available_ram_per_instance: None
available_cpu_per_instance: None
raw_nb_of_instances: None
nb_of_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
OnPremise id-ec03e8-Default-on-premise
carbon_footprint_fabrication: 600 kilogram
power: 300 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
server_utilization_rate: 0.9 dimensionless
idle_power: 50 watt
ram: 128 gigabyte
cpu_cores: 24 core
power_usage_effectiveness: 1.2 dimensionless
base_ram_consumption: 0 gigabyte
base_cpu_consumption: 0 core
storage: id-48d017-Default-SSD-storage
fixed_nb_of_instances: None
calculated_attributes:
hour_by_hour_cpu_need: None
hour_by_hour_ram_need: None
available_ram_per_instance: None
available_cpu_per_instance: None
raw_nb_of_instances: None
nb_of_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
Storage
Storage id-ea4115-Default-HDD-storage
carbon_footprint_fabrication: 20 kilogram
power: 4.2 watt
lifespan: 4 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
long_term_storage_required: None
instances_power: None
idle_power: 0 watt
storage_capacity: 1 terabyte
power_usage_effectiveness: 1.2 dimensionless
data_replication_factor: 3 dimensionless
data_storage_duration: 5 year
base_storage_need: 0 terabyte
calculated_attributes:
storage_delta: None
full_cumulative_storage_need: None
raw_nb_of_instances: None
nb_of_instances: None
nb_of_active_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
Storage id-132b7b-Default-SSD-storage
carbon_footprint_fabrication: 160 kilogram
power: 1.3 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
long_term_storage_required: None
instances_power: None
idle_power: 0 watt
storage_capacity: 1 terabyte
power_usage_effectiveness: 1.2 dimensionless
data_replication_factor: 3 dimensionless
data_storage_duration: 5 year
base_storage_need: 0 terabyte
calculated_attributes:
storage_delta: None
full_cumulative_storage_need: None
raw_nb_of_instances: None
nb_of_instances: None
nb_of_active_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
Overwriting default builders attributes
Any default builder attribute can be overwritten, for example:
from efootprint.abstract_modeling_classes.source_objects import SourceValue
from efootprint.constants.units import u
print(default_ssd("My custom default SSD with higher carbon intensity", average_carbon_intensity=SourceValue(300 * u.g / u.kWh)))
Storage id-a2069f-My-custom-default-SSD-with-higher-carbon-intensity
carbon_footprint_fabrication: 160 kilogram
power: 1.3 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 300.0 gram / kilowatt_hour
long_term_storage_required: None
instances_power: None
idle_power: 0 watt
storage_capacity: 1 terabyte
power_usage_effectiveness: 1.2 dimensionless
data_replication_factor: 3 dimensionless
data_storage_duration: 5 year
base_storage_need: 0 terabyte
calculated_attributes:
storage_delta: None
full_cumulative_storage_need: None
raw_nb_of_instances: None
nb_of_instances: None
nb_of_active_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
BoaviztAPI builders
These builders make use of Boavizta’s API to create objects with their full technical characteristics from fewer information like server name and cloud provider.
BoaviztAPI server builders
Cloud server from cloud provider and server name
Autoscaling id-5a6224-aws-m52exlarge-instances
carbon_footprint_fabrication: 48.0 kilogram
power: 25.94 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
server_utilization_rate: 0.9 dimensionless
idle_power: 0 watt
ram: 384.0 gigabyte
cpu_cores: 48.0 core
power_usage_effectiveness: 1.2 dimensionless
base_ram_consumption: 0 gigabyte
base_cpu_consumption: 0 core
storage: id-e5af41-Default-SSD-storage
calculated_attributes:
hour_by_hour_cpu_need: None
hour_by_hour_ram_need: None
available_ram_per_instance: None
available_cpu_per_instance: None
raw_nb_of_instances: None
nb_of_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
# The server type can be changed, as well as lifespan, idle_power, power_usage_effectiveness and server_utilization_rate
from efootprint.core.hardware.servers.serverless import Serverless
print(get_cloud_server(
"aws", "m5.xlarge", SourceValue(100 * u.g / u.kWh), base_efootprint_class=Serverless, lifespan=SourceValue(7 * u.year)))
Serverless id-22ecc6-aws-m52exlarge-instances
carbon_footprint_fabrication: 48.0 kilogram
power: 25.94 watt
lifespan: 7 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
server_utilization_rate: 0.9 dimensionless
idle_power: 0 watt
ram: 384.0 gigabyte
cpu_cores: 48.0 core
power_usage_effectiveness: 1.2 dimensionless
base_ram_consumption: 0 gigabyte
base_cpu_consumption: 0 core
storage: id-f67bfe-Default-SSD-storage
calculated_attributes:
hour_by_hour_cpu_need: None
hour_by_hour_ram_need: None
available_ram_per_instance: None
available_cpu_per_instance: None
raw_nb_of_instances: None
nb_of_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
On premise server from config
print(on_premise_server_from_config(
"My server", nb_of_cpu_units=2, nb_of_cores_per_cpu_unit=24,nb_of_ram_units=6,
ram_quantity_per_unit_in_gb=16, average_carbon_intensity=SourceValue(100 * u.g / u.kWh),base_ram_consumption=SourceValue(1 * u.MB)))
OnPremise id-a67548-My-server
carbon_footprint_fabrication: 670.0 kilogram
power: 520.99 watt
lifespan: 6 year
fraction_of_usage_time: 1 dimensionless
average_carbon_intensity: 100.0 gram / kilowatt_hour
server_utilization_rate: 0.7 dimensionless
idle_power: 0 watt
ram: 96 gigabyte
cpu_cores: 48 core
power_usage_effectiveness: 1.4 dimensionless
base_ram_consumption: 1 megabyte
base_cpu_consumption: 0 core
storage: id-9036da-Default-SSD-storage
fixed_nb_of_instances: None
calculated_attributes:
hour_by_hour_cpu_need: None
hour_by_hour_ram_need: None
available_ram_per_instance: None
available_cpu_per_instance: None
raw_nb_of_instances: None
nb_of_instances: None
instances_fabrication_footprint: None
instances_energy: None
energy_footprint: None
Job builder from Boavizta’s ecobenchmark data
from efootprint.builders.usage.job_ecobenchmark.ecobenchmark_job_builder import ecobenchmark_job
server = default_autoscaling()
storage = default_ssd()
job = ecobenchmark_job(
"test job", server, data_upload=SourceValue(1 * u.MB), data_download=SourceValue(1 * u.MB), data_stored=SourceValue(1 * u.MB),
technology='php-symfony')
print(job)
2024-10-04 19:53:58,628 - INFO - File /ecobenchmark_results__raw.csv already exists, we do not overwrite it
Job id-d00f7d-test-job
job_type: undefined
server: id-8ce298-Default-autoscaling
data_upload: 1 megabyte
data_download: 1 megabyte
data_stored: 1 megabyte
request_duration: 1 second
ram_needed: 6.15 megabyte
cpu_needed: 0.08 core
description:
calculated_attributes:
hourly_occurrences_across_usage_patterns: None
hourly_avg_occurrences_across_usage_patterns: None
hourly_data_upload_across_usage_patterns: None
hourly_data_stored_across_usage_patterns: None
# List of available technologies
from efootprint.builders.usage.job_ecobenchmark.ecobenchmark_job_builder import get_ecobenchmark_technologies
print(get_ecobenchmark_technologies())
['go-pgx', 'jvm-kotlin-spring', 'node-express-sequelize', 'php-symfony', 'rust-actix-sqlx']