README.md

API for carculator

Use the API to calculate the environmental impacts of vehicles and their components.

Installation

To install the API, clone this repository and install the dependencies.

To run the API using Flask's development server, you can use the following command:

  
    flask run
    

or using gunicorn:

  
    gunicorn --workers 3 wsgi:app
  

Usage

    import requests
    import xarray as xr
    
    # Define the URL for the Flask endpoint
    url = "http://127.0.0.1:8000/calculate-lca"
    
    # Create the data payload to send to the server
    data = {
        "nomenclature": "tcs", # if using TCS terms, otherwise use "carculator"
        "country_code": "CH", # two-digit ISO country code
        "vehicles": [
            {
                "id": "ICEV001",
                "vehicle_type": "car", # mandatory
                "tsa": "B",
                "year": 2020,
                "fzklasse": 30008,
                "leer": 1400,
                "nutz": 500,
                "gesamt": 1900,
                "kw": 110,
                "kw_sl": 110,
                "tank": 45,
                "ver_abs": 7.8,
                "ver": 7.8,
                "bat_km_tcs": 650,
                "bat_km_WLTP": 0
            },
            {
                "id": "BEV001",
                "vehicle_type": "car",
                "year": 2023,
                "tsa": "E",
                "fzklasse": 30024,
                "leer": 2200,
                "nutz": 450,
                "gesamt": 2650,
                "kw": 150,
                "kw_sl": 150,
                "tank": 0,
                "ver_abs": 15.5,
                "bat_km_tcs": 400,
                "bat_cap": 80,
                "bat_typ": "NMC-622",
                "bat_km_WLTP": 450,
                "ver_strom": 17,
            },
            {
                "id": "PHEV001",
                "vehicle_type": "car",
                "year": 2025,
                "tsa": "C1",
                "fzklasse": 30002,
                "leer": 1700,
                "nutz": 400,
                "gesamt": 2100,
                "kw": 90,
                "kw_sl": 160,
                "tank": 40,
                "ver_abs": 5.2,
                "bat_km_tcs": 600,
                "bat_cap": 15,
                "bat_typ": "NMC-811",
                "bat_km_WLTP": 50,
                "ver_strom": 10,
                "ver": 5.0,
            }
        ],
    }
    
    # Send the POST request
    response = requests.post(url, json=data)
    
    # Check if the request was successful
    if response.status_code == 200:
        # Parse the JSON response
        result = response.json()
    
        array = xr.DataArray.from_dict(result["vehicles"][0]["results"])
        print(array)
    
    else:
        print(f"Failed to get LCA results. Status code: {response.status_code}")
        print("Error:", response.text)