Installation

Installing Goxpyriment to create your own experiments¶

Install Git, then Go on your computer (if you are new to this, consult the detailed instructions).
clone goxpyriment Github repository, by opening a Terminal (App Git Bash under Windows), and executing the command-line
```
git clone https://github.com/chrplr/goxpyriment.git
```
Later, a simple git pull will suffice to upgrade to the most recent version.

Alternatively you can just download the ZIP and unzip it.
In the Terminal, execute:

cd goxpyriment
./build-all.sh

This compiles the codes in examples/*. If all goes well, the _build folder should now contain executable (apps) for many experiments. (On Linux/macOS you can also use make all.)

The first time, this will take a while because Go needs to download several libraries. Once done, compilation will be fast.

Install optional additional tools

To install a local web server on port 8080 on your computer to access goxperiment's documentation install pkgsite with:

   go install golang.org/x/pkgsite/cmd/pkgsite@latest

Then

   cd goexpyriment
   pkgsite

and open <http://127.0.0.1:8080> in your browser.

If you like to use debuggers, you can install delve.

Program your own experiment¶

Once goxpyriment is installed, follow the step-by-step guide in Creating Your Own Experiment, which walks you through writing, running, building, and sharing your own experiment. For background and reference, see Getting Started, the examples' source codes, and the available functions.