Back to JESS API

Get the EPW Stats Info


Use GET /epw/json/<dataset_name> to retrieve the stats info of the data file (.epw) of a given dataset name. The contents of the stats is not the same as the .stat file.


Synopsis

Return object

A successful /epw/json/<dataset_name> transaction returns the stats of the given dataset. The datasets can be from either energyplus.net or climate.onebuilding.org. The dataset name is normally the name of the EPW file without the extension .epw.

{
    "location": {
        "state": "AL",
        "country": "ISL",
        "timeZone": 0.0,
        "source": "ISD",
        "stationID": "040820",
        "station": "Hornafjordur AP",
        "elevation": 7.3,
        "latitude": 64.296,
        "longitude": -15.227
    },
    "id": "ISL_AL_Hornafjordur.AP.040820_TMYx.epw",
    "links": null,
    "groudTemps": {
        "tempRecords": [
            {
                "depth": 0.5,
                "soilDensity": -1.0,
                "monthlyMeans": [
                    0.07,
                    0.95,
                    2.68,
                    4.31,
                    7.4,
                    9.03,
                    9.48,
                    8.65,
                    6.75,
                    4.37,
                    2.03,
                    0.49
                ],
                "soilSpecificHeat": -1.0,
                "soilConductivity": -1.0
            },
            {
                "depth": 2.0,
                "soilDensity": -1.0,
                "monthlyMeans": [
                    1.29,
                    1.5,
                    2.49,
                    3.58,
                    5.96,
                    7.48,
                    8.23,
                    8.06,
                    6.98,
                    5.34,
                    3.49,
                    2.04
                ],
                "soilSpecificHeat": -1.0,
                "soilConductivity": -1.0
            },
            {
                "depth": 4.0,
                "soilDensity": -1.0,
                "monthlyMeans": [
                    2.55,
                    2.4,
                    2.83,
                    3.45,
                    5.02,
                    6.2,
                    6.96,
                    7.14,
                    6.67,
                    5.7,
                    4.45,
                    3.32
                ],
                "soilSpecificHeat": -1.0,
                "soilConductivity": -1.0
            }
        ],
        "n": 3
    },
    "holidays": {
        "leapYear": false,
        "holidays": null,
        "daylightSavingEndDay": "0",
        "daylightSavingStartDay": "0",
        "numberOfHolidays": 0
    },
    "comments1": "COMMENTS 1,\"NCEI ISD - #years=[47] Period of Record=1973-2019; Jan=1986; Feb=1983; Mar=1980; Apr=1997; May=1988; Jun=1999; Jul=1999; Aug=2001; Sep=1987; Oct=2009; Nov=2004; Dec=1988\"",
    "dataPeriod": {
        "name": "Data",
        "n": 1,
        "timesteps": 1,
        "startDay": "1/ 1",
        "endDay": "12/31",
        "startDayOfWeek": "Sunday"
    },
    "sourceUrl": "",
    "comments2": "COMMENTS 2,\"Downloaded from Climate.Onebuilding.org -- Ground temps represent undisturbed earth temperatures - calculated from this weather data.\"",
    "dailyMin": [
        [
            0.3,
            -5.1,
            55.0,
            100409.0,
            263.0,
            0.0,
            0.0,
            10.0,
            4.6,
            3.0,
            3.0,
            9.19099999E8,
            0.0,
            0.0
        ],
        ...

    ],
    "windDists": [
        [
            [
                5.859001512859298,
                0.07545662100456621
            ],
            [
                6.1648177496038,
                0.07203196347031963
            ],
            [
                6.007445008460237,
                0.06746575342465753
            ],
            [
                6.1654736842105295,
                0.05422374429223744
            ],
            [
                6.157534246575338,
                0.06666666666666667
            ],
            [
                5.768014059753952,
                0.06495433789954339
            ],
            [
                5.532641509433963,
                0.06050228310502283
            ],
            [
                5.27907375643224,
                0.06655251141552511
            ],
            [
                5.457213114754093,
                0.06963470319634703
            ],
            [
                5.942678571428573,
                0.0639269406392694
            ],
            [
                6.353996447602133,
                0.06426940639269406
            ],
            [
                5.570488322717626,
                0.053767123287671234
            ],
            [
                5.7415708812260595,
                0.05958904109589041
            ],
            [
                5.0545454545454565,
                0.04018264840182648
            ],
            [
                5.8927437641723355,
                0.05034246575342466
            ],
            [
                6.027552674230145,
                0.0704337899543379
            ]
        ],
        ...
    ],
    "dailyMax": [
        [
            2.6,
            -1.5,
            80.0,
            101241.0,
            291.0,
            0.0,
            19.0,
            338.0,
            12.5,
            10.0,
            10.0,
            9.99999999E8,
            0.0,
            0.0
        ],
        ...

    ],
    "designConditions": {
        "source": "2017 ASHRAE Handbook -- Fundamentals - Chapter 14 Climatic Design Information",
        "dcs": {
            "Extremes": {
                "WS010 [m/s]": 18.8,
                "WS025 [m/s]": 15.4,
                "WS050 [m/s]": 13.4,
                "WBmax [C]": -10.7,
                "DBmin_mean [C]": 19.2,
                "DBmax_mean [C]": 2.1,
                "DBmin_stddev [C]": 2.5,
                "DBmax_stddev [C]": -12.2,
                "DBmin05years [C]": 20.9,
                "DBmax05years [C]": -13.4,
                "DBmin10years [C]": 22.4,
                "DBmax10years [C]": -14.6,
                "DBmin20years [C]": 23.7,
                "DBmax20years [C]": -16.1,
                "DBmin50years [C]": 25.5,
                "DBmax50years [C]": -11.9
            },
            "Cooling": {
                "HottestMonth []": 7.0,
                "DBR [C]": 4.4,
                "DB004 [C]": 15.6,
                "WB_DB004 [C]": 12.1,
                "DB010 [C]": 14.3,
                "WB_DB010 [C]": 11.5,
                "DB020 [C]": 13.5,
                "WB_DB020 [C]": 11.1,
                "WB004 [C]": 12.9,
                "DB_WB004 [C]": 14.4,
                "WB010 [C]": 12.2,
                "DB_WB010 [C]": 13.5,
                "WB020 [C]": 11.7,
                "DB_WB020 [C]": 12.9,
                "WS_DB004 [m/s]": 4.9,
                "WD_DB004 [deg]": 180.0,
                "DP004 [C]": 12.1,
                "HR_DP004 []": 8.8,
                "DB_DP004 [C]": 13.4,
                "DP010 [C]": 11.6,
                "HR_DP010 []": 8.5,
                "DB_DP010 [C]": 12.8,
                "DP020 [C]": 11.0,
                "HR_DP020 []": 8.2,
                "DB_DP020 [C]": 12.3,
                "EN004 [kJ/kg]": 36.5,
                "DB_EN004 [C]": 14.6,
                "EN010 [kJ/kg]": 34.9,
                "DB_EN010 [C]": 13.7,
                "EN020 [kJ/kg]": 33.5,
                "DB_EN020 [C]": 12.9,
                "#Hrs_8-4_&_DB-12.8/20.6 []": 18.4
            },
            "Heating": {
                "ColdestMonth []": 12.0,
                "DB996 [C]": -8.5,
                "DB990 [C]": -6.9,
                "DP996 [C]": -16.3,
                "HR_DP996 []": 0.9,
                "DB_DP996 [C]": -7.9,
                "DP990 [C]": -14.1,
                "HR_DP990 []": 1.1,
                "DB_DP990 [C]": -6.3,
                "WS004c [m/s]": 22.1,
                "DB_WS004c [C]": 1.3,
                "WS010c [m/s]": 20.0,
                "DB_WS010c [C]": 0.4,
                "WS_DB996 [m/s]": 6.5,
                "WD_DB996 [deg]": 340.0
            }
        },
        "dcstrs": [
            "Heating",
            "12",
            "-8.5",
            "-6.9",
            "-16.3",
            "0.9",
            "-7.9",
            "-14.1",
            "1.1",
            "-6.3",
            "22.1",
            "1.3",
            "20",
            "0.4",
            "6.5",
            "340",
            "Cooling",
            "7",
            "4.4",
            "15.6",
            "12.1",
            "14.3",
            "11.5",
            "13.5",
            "11.1",
            "12.9",
            "14.4",
            "12.2",
            "13.5",
            "11.7",
            "12.9",
            "4.9",
            "180",
            "12.1",
            "8.8",
            "13.4",
            "11.6",
            "8.5",
            "12.8",
            "11",
            "8.2",
            "12.3",
            "36.5",
            "14.6",
            "34.9",
            "13.7",
            "33.5",
            "12.9",
            "18.4",
            "Extremes",
            "18.8",
            "15.4",
            "13.4",
            "-10.7",
            "19.2",
            "2.1",
            "2.5",
            "-12.2",
            "20.9",
            "-13.4",
            "22.4",
            "-14.6",
            "23.7",
            "-16.1",
            "25.5",
            "-11.9"
        ],
        "unknown": "",
        "n": 1
    },
    "notablePeriods": {
        "periods": [
            {
                "name": "Summer - Week Nearest Max Temperature For Period",
                "type": "Extreme",
                "startDate": "7/24",
                "endDate": "7/30"
            },
            {
                "name": "Summer - Week Nearest Average Temperature For Period",
                "type": "Typical",
                "startDate": "6/12",
                "endDate": "6/18"
            },
            {
                "name": "Winter - Week Nearest Min Temperature For Period",
                "type": "Extreme",
                "startDate": "12/20",
                "endDate": "12/26"
            },
            {
                "name": "Winter - Week Nearest Average Temperature For Period",
                "type": "Typical",
                "startDate": "1/11",
                "endDate": "1/17"
            },
            {
                "name": "Autumn - Week Nearest Average Temperature For Period",
                "type": "Typical",
                "startDate": "10/10",
                "endDate": "10/16"
            },
            {
                "name": "Spring - Week Nearest Average Temperature For Period",
                "type": "Typical",
                "startDate": "2/15",
                "endDate": "2/21"
            }
        ],
        "n": 6
    }
}

Example using curl://

Send the /epw/json/<dataset_name> command using curl:

curl https://api.ensims.com/jess_web/api/epw/json/ISL_AL_Hornafjordur.AP.040820_TMYx

On success, the stats of the EPW file will be returned in a JSON object. If the specified dataset is not found, an HTTP 404 Not Found error will be returned.

Example using Python Requests

Make sure Requests is correctly installed in your Python environment, and run the following lines:

import requests

# Security is not required
r = requests.get('https://api.ensims.com/jess_web/api/epw/json/ISL_AL_Hornafjordur.AP.040820_TMYx')

# Show returned object  
r.json()