abound

README

Abound

This package defines ABOUND specific methods for reading input and generating output according to the expected configuration of environemnt variables. This generally will not need to change for your algorithm.

Documentation

Overview

Package abound provides some helper utilities for reading configuration and writing output images.

Index

• Constants
• func LoadConfig(v any) error
• func WritePNG(img image.Image) error
• func WriteSVG(svg string) error

Constants

const (
	ConfigPathEnvVar = "ABOUND_CONFIG_PATH"
	OutputPathEnvVar = "ABOUND_OUTPUT_PATH"
)

Functions

func LoadConfig

func LoadConfig(v any) error

LoadConfig parses an ABOUND configuration from its specified location into the provided structure.

func WritePNG

func WritePNG(img image.Image) error

WritePNG writes a PNG-formatted image to the target output path.

func WriteSVG

func WriteSVG(svg string) error

WriteSVG writes an SVG-formatted string to the target output path.