@bimenergy/be-format-utils v3.1.101

Usage

Example below shows minimal example:

• Generate building from map feature with polygon coordinates (GeoJson feature)
• Generate building from surfaces through floorplan data structure
• Generate building from planarGeometry

import {
  generateBuilding,
  generateBuildingFromPlanarGeometry
} from '@bimenergy/be-format-utils';

// this is the most common way to generate a building
const defaultBuilding = generateBuilding(); // simple squared building located at center of the world

const regeneratedBuilding = generateBuilding(defaultBuilding); // will try to reuse custom settings such as storey levels

const options={
  openings: true // defaults to true, will generate openings according to the glazing percentage
  constructions: {} // a map with constructionId:construction for generation of offset according to construction widths. 
  // Also the selected typology should be put in this object with constructionType:construction (ExteriorWall:{}, InteriorWall:{}, and so on for the defaults)
};

const buildingWithOptions = generateBuilding(null, options);

const planarGeometry = [[[-10, -10, 0], [-10, 10, 0], [10, 10, 0], [10, -10, 0]]];

const coordinates = [
  [
    [
      12.971926,
      55.5945889
    ],
    [
      12.97213,
      55.5945662
    ],
    [
      12.9722491,
      55.5949078
    ],
    [
      12.9720451,
      55.5949305
    ],
    [
      12.9720136,
      55.59484
    ],
    [
      12.9719498,
      55.5946571
    ],
    [
      12.971926,
      55.5945889
    ]
  ]
];

const point = [
    12.9719498,
    55.5946571
];

const feature = {
    geometry: {
        coordinates,
        type: 'Polygon'
    },
    properties: {
        name: 'minimal default geometric building'
    }
};

const buildingFromFeature = generateBuilding(feature);

const properties={}; 
const location=[0.1, 0.1]; // longitude, latitude (location is mandatory so the default is in the center of the world, [0,0] is not valid coordinate in Turf)
const centralize=true; // if the center of the planarGeometry should be calculated and the shape should be centered from this

const buildingFromPlanarGeometry = generateBuildingFromPlanarGeometry(planarGeometry, properties, options, location, centralize);

Other util functionality:

• Get heated area

import {
  getHeatedArea
} from '@bimenergy/be-format-utils';

const area = getHeatedArea(building);

• Get default project (should change to "createDefaultProject".. )

import {
  getDefaultProject
} from '@bimenergy/be-format-utils';

// optional
const options = {
  defaultActivities: true,
  defaultVentilations: true,
  defaultCatalog: true, // currently returns typologies, constructions, materials and windowtypes
  defaultHeatPumps: true
};

const projectName = 'My project';

const defaultProject = getDefaultProject(projectName, options);

• Generate climate schedule from VIP-Energy climate file

const lon = 'a valid longitude';
const lat = 'a valid latitude;
const year = '2010';
const climateFileDescription = 'in Map the project id is used here';

const climateFile = await fetch(`http://ec2-23-23-243-100.compute-1.amazonaws.com/lat=${lat}lon=${lon}year=${year}description=${climateFileDescription}`, {
  method: 'GET',
  headers: {
    'Accept': 'text/plain',
    'Content-Type': 'text/plain'
  }
}).then(result=>result.text());

const climateFileName = `LAT${lat}_LON${lon}`; // example from Map on how to name a generated climate file

const climateSchedule = parseClimateFile(climateFile, climateFileName);

Release new package version (last updated 200520)

0. update modules
1. npm run test

2. git commit
   3. npm version patch
3. npm run build (must be run after version to get the proper version number internally)
   5. git push --follow-tags
   6. npm publish