starter-go

ABOUND Starter Repo - Go

This is a starter repository for an ABOUND algorithm written in Go.

• Unsure on what ABOUND is? Check out https://abound.art
• Looking for another language? Check out our other options for starter repos here
• New to Go Modules? Learn the basics here.

What is in this repo

This repo includes all of the scaffolding to build an algorithm for ABOUND. That means:

1. Reading in the JSON configuration for a run
2. Generating art (using a Lorenz attractor as an example)
3. Writing the output to a file

In short, this repo does everything except implement your art algorithm, which will generally look like this:

// Config is all the parameters your algorithm takes as input.
type Config struct {
  Seed int `json:"seed"`
}

func Run(cfg *Config) image.Image {
  // Your code here which generates the image from the config.
}

Run locally + Testing your code

export ABOUND_CONFIG_PATH=example_input.json
export ABOUND_OUTPUT_PATH=output.png
go run ./cmd/algo

Will generate a piece of art at output.png that looks like this:

To start implementing your algorithm, replace the Config struct and Run function in algo.go with your own. It's also worth noting that the example algorithm produces raster images, meaning they're made of pixels and are output as PNG files, but you can also write algorithms that produce vector images, meaning they're made of geometric shapes and are output as SVG files.

As a Docker container

To test the algorithm in a Docker container, run:

./scripts/build_image.sh
./scripts/run_image.sh <config path> <output path>

Where <config path> defaults to example_input.json and <output path> defaults to output.png.

Packaging for Deployment

Algorithms are uploaded to ABOUND as Docker containers. The example algo can be built by running:

./scripts/build_image.sh

Which will build the example image and tag it abound-starter-go.

Deploying on ABOUND

Head to https://abound.art/artists for the most recent instructions on how to upload your algorithm once it is written. Make sure to read through the constraints carefully to make sure that your algorithm conforms to them prior to submission.

Once you're ready to upload, tag and push the image with:

docker tag <local tag> <image name given by ABOUND>
docker push <image name given by ABOUND>

If you haven't changed the example configuration in this repo, the <local tag> defaults to abound-starter-go.

The docker push command will fail if you aren't already authenticated with your ABOUND credentials.