https://github.com/arran4/heatplot
This program takes a formula and plots the "heat" for any particular location
https://github.com/arran4/heatplot
experiment golang graph heatplot maths plot testing
Last synced: 3 months ago
JSON representation
This program takes a formula and plots the "heat" for any particular location
- Host: GitHub
- URL: https://github.com/arran4/heatplot
- Owner: arran4
- License: afl-3.0
- Created: 2021-12-12T02:45:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-04-04T07:19:59.000Z (3 months ago)
- Last Synced: 2026-04-04T08:28:07.428Z (3 months ago)
- Topics: experiment, golang, graph, heatplot, maths, plot, testing
- Language: Go
- Homepage:
- Size: 34.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# heatPlot
`heatPlot` is a Go tool for generating animated heatmaps (GIFs) from mathematical functions. It parses mathematical expressions involving variables `x`, `y`, and `t` (time), and renders them as a heatmap.
## Installation
Ensure you have Go installed (Go 1.22+ recommended).
Clone the repository and install the dependencies:
```bash
git clone https://bitbucket.org/arran4/heatplot.git
cd heatplot
go mod tidy
```
## Usage
There are three main commands available in the `cmd` directory:
### 1. heatPlot
Generates a heatmap GIF from a provided mathematical formula.
**Build:**
```bash
go build -o heatPlot cmd/heatPlot/main.go
```
**Run:**
```bash
./heatPlot [flags] "formula"
```
**Flags:**
- `-hcc`: Heat colour count (default 126).
- `-speed`: Duration between frames (default 100ms).
- `-pointSize`: Scale of x/y steps (default 0.1).
- `-scale`: Magnification (default 2).
- `-tlb`: Time lower bound (start T, default 0).
- `-tub`: Time upper bound (end T, default 100).
- `-size`: Cartesian plane size (default 100, i.e., -100 to 100).
- `-outputFile`: Output filename (default "./out.gif").
- `-footerText`: Footer text (default "http://github.com/arran4/").
**Example:**
```bash
./heatPlot -outputFile="example.gif" "y = x * sin(t/10)"
```
### 2. heatPlotRandom
Generates random functions and renders one that meets certain "interestingness" criteria (complexity, movement).
**Build:**
```bash
go build -o heatPlotRandom cmd/heatPlotRandom/main.go
```
**Run:**
```bash
./heatPlotRandom [flags]
```
**Flags:**
Similar to `heatPlot`, with additional criteria for random generation.
### 3. whatFunctions
Lists all available single and double parameter functions supported by the parser.
**Build:**
```bash
go build -o whatFunctions cmd/whatFunctions/main.go
```
**Run:**
```bash
./whatFunctions
```
## Formula Syntax
The parser supports:
- Variables: `x`, `y`, `t`
- Constants: Numbers
- Operators: `+`, `-`, `*`, `/`, `%` (modulus), `^` (power)
- Functions: `sin`, `cos`, `tan`, `abs`, `max`, `min`, `pow`, etc. (See `whatFunctions` for full list)
- Grouping: `()`
The parser generally expects an equation, often in the form `LHS = RHS`. The heatmap value is calculated as `RHS - LHS`.
## Examples
### Sine Wave
`y = x * sin(t/10)`
### Complex Interaction
`y = x * sin(t/10) + y * cos(t/10)`
### Ripple
`y = sin(sqrt(x^2 + y^2) - t/5)`
### Interference
`y = sin(x/10) + cos(y/10) * sin(t/10)`
## Development
### Prerequisites
- Go 1.22 or later
- Make
### Building
To regenerate the parser from `calc.y`:
```bash
make setup
make yacc
```
### Testing
Run the tests:
```bash
go test ./...
```
## License
This project is licensed under the Academic Free License version 3.0 (AFL-3.0) - see the [LICENSE](LICENSE) file for details.