NHMzh Vizualization Services

This repository contains the code for the Vizualization Services of the NHMzh project.

The Services

Minio

• Used for storing files.
• Buckets:
  • ifc-files (the raw ifc files)
  • ifc-fragment-files (compressed counterparts to the ifc files, converted to 'fragments')

viz_ifc

Listens to a Kafka topic with links to IFC files

• Loads the ifc file from Minio
• Converts to fragments, compresses
• Saves compressed fragments back to Minio
• TODO: update 'fragments-files' Kafka topic.

Uses the @ThatOpen Companies library.

viz_lca-cost

This consumer writes listens to the cost and lca kafka topics and writes data to Azure SQL DB. Cost and LCA data is captured in Azure SQL DB. This allows for reporting of the data over time.

Prerequisites

• Docker
• Docker Compose
• Node.js
• Go

Environment Variables

Create a .env file in the root directory of the repository with the following variables:

MINIO_ROOT_USER=ROOTUSER
MINIO_ROOT_PASSWORD=CHANGEME123

MINIO_ACCESS_KEY=ROOTUSER
MINIO_SECRET_KEY=CHANGEME123

MINIO_ENDPOINT=minio
MINIO_PORT=9000

MINIO_USE_SSL=false

MINIO_IFC_BUCKET=ifc-files
MINIO_FRAGMENTS_BUCKET=ifc-fragment-files
MINIO_LCA_COST_DATA_BUCKET=lca-cost-data

VIZ_KAFKA_IFC_CONSUMER_ID=viz-ifc-consumer
VIZ_KAFKA_IFC_PRODUCER_ID=viz-ifc-producer
VIZ_KAFKA_IFC_GROUP_ID=viz-ifc
VIZ_KAFKA_DATA_GROUP_ID=viz-data

IFC_API_PORT=4242
PBI_SERVER_PORT=3000

KAFKA_BROKER=kafka:9093
KAFKA_IFC_TOPIC=ifc-files
KAFKA_LCA_TOPIC=lca-data
KAFKA_COST_TOPIC=cost-data

AZURE_DB_SERVER=your-server-name.database.windows.net
AZURE_DB_PORT=1234
AZURE_DB_USER=your-user-name
AZURE_DB_PASSWORD=your-password
AZURE_DB_DATABASE=your-database-name

Make sure to replace ROOTUSER and CHANGEME123 with your own credentials.

Running the services

To run the services, navigate to the root directory of the repository and run the following command:

docker-compose up --build -d

Stopping the services

To stop the services, navigate to the root directory of the repository and run the following command:

docker-compose down

Access the MinIO Console

To access the MinIO Console, navigate to http://localhost:9001. You will need to use the credentials ROOTUSER and CHANGEME123 to log in. Or whatever you have set in the .env file.

Tests

Integration Tests

Follow the instructions in the integration-tests/README.md file.