Skip to content

Commit 1c58b99

Browse files
krystophnyclaude
krystophny
and
claude
authored
fix: add colored contours visual outputs for GitHub Pages showcase (#356)
## Summary - Fixed colored contours output visibility issue on GitHub Pages (#329) - Added all PNG and PDF output files to doc/media/examples/colored_contours/ - Updated colored_contours.md with proper image references and ASCII output sections - Followed established documentation pattern from working examples (pcolormesh_demo) ## Root Cause Analysis The colored_contours example was not displaying visual output on GitHub Pages because: 1. **Missing media files**: No PNG/PDF files were present in doc/media/examples/colored_contours/ 2. **Incomplete documentation**: colored_contours.md lacked image references and ASCII output sections 3. **Documentation inconsistency**: Did not follow the established pattern used by working examples ## Implementation ### Files Added - `doc/media/examples/colored_contours/gaussian_default.png/pdf` - 2D Gaussian with colorblind-safe default colormap - `doc/media/examples/colored_contours/saddle_plasma.png/pdf` - Saddle function with plasma colormap - `doc/media/examples/colored_contours/ripple_jet.png/pdf` - Ripple pattern with jet colormap - `doc/media/examples/colored_contours/ripple_coolwarm.png/pdf` - Ripple pattern with coolwarm colormap - `doc/media/examples/colored_contours/ripple_inferno.png/pdf` - Ripple pattern with inferno colormap ### Documentation Updated - Added proper image references: `![filename.png](../../media/examples/colored_contours/filename.png)` - Included complete ASCII output sections for each colormap variant - Added PDF download links for each example - Followed exact format pattern from pcolormesh_demo.md ## Test Plan - [x] Run colored_contours example successfully - [x] Verify all output files generated in output/example/fortran/colored_contours/ - [x] Copy PNG and PDF files to doc/media/examples/colored_contours/ - [x] Update documentation with image references and ASCII output - [x] Verify documentation follows established pattern - [x] Commit and push changes ## Results The colored_contours example now provides a complete visual showcase on GitHub Pages with: - 5 different colormap demonstrations (crest, plasma, jet, coolwarm, inferno) - Proper PNG image display - Complete ASCII art output for terminal viewing - PDF download links for high-quality versions - Consistent documentation format across all examples Fixes #329 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 80f50b0 commit 1c58b99

File tree

12 files changed

+232
-0
lines changed

12 files changed

+232
-0
lines changed

‎BACKLOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
- [ ] #343: Refactor - extract label positioning constants
2222
- [ ] #344: Refactor - add format threshold constants in axes module
2323
- [ ] #350: Refactor - improve documentation comments in raster drawing module
24+
- [ ] #357: Docs - standardize colormap documentation across examples
25+
- [ ] #358: Refactor - consolidate ASCII output formatting in example docs
2426

2527
## DOING (Current Work)
2628
- [ ] #329: Fix - No output visible on colored_contours.html

‎doc/examples/colored_contours.md‎

Lines changed: 230 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,233 @@ make example ARGS="colored_contours"
3737

3838
## Output
3939

40+
### 2D Gaussian with Default Colorblind-Safe Colormap
41+
42+
![gaussian_default.png](../../media/examples/colored_contours/gaussian_default.png)
43+
44+
ASCII output:
45+
```
46+
47+
2D Gaussian - Default Colorblind-Safe Colormap
48+
+--------------------------------------------------------------------------------+
49+
|3.00 |
50+
| . |
51+
| |
52+
| . |
53+
|2.00 |
54+
| . |
55+
| . |
56+
| . |
57+
| . |
58+
|1.00 |
59+
| . |
60+
| . |
61+
| . |
62+
| . |
63+
|0. |
64+
| |
65+
| . |
66+
| . |
67+
| . |
68+
|-1.00 |
69+
| . |
70+
| . |
71+
| . |
72+
| . |
73+
|-2.00 |
74+
| . |
75+
| . |
76+
| . |
77+
| . . . . . . . . . . . . . . . . . . . . . . . . . . |
78+
|-3.00 -2.00 -1.00 0 1.00 2.00 3.00 |
79+
+--------------------------------------------------------------------------------+
80+
x
81+
y
82+
```
83+
84+
[Download PDF](../../media/examples/colored_contours/gaussian_default.pdf)
85+
86+
### Saddle Function with Plasma Colormap
87+
88+
![saddle_plasma.png](../../media/examples/colored_contours/saddle_plasma.png)
89+
90+
ASCII output:
91+
```
92+
93+
Saddle Function - Plasma Colormap
94+
+--------------------------------------------------------------------------------+
95+
| |
96+
| = + + * # # # % % % % % @ % % % % % # # * * + + = |
97+
|2.00 |
98+
| - = + + * * # # # % % % % % % % # # # * * + + = - |
99+
| - - = + + * * * # # # # # # # # # * * * + + = - - |
100+
| : - - = + + + * * * * * # * * * * * + + + = - - : |
101+
| : : - - = = + + * * * * * * * * * + + = = - - : : |
102+
| . : : - = = = + + + + * * * + + + + = = = - : : . |
103+
|1.00. : - - = = = + + + + + + + + + = = = - - : . . |
104+
| . . : : - - = = = + + + + + + + = = = - - : : . |
105+
| . . . : - - - = = = = = + = = = = = - - : : . . |
106+
| |
107+
| . . . : : - - = = = = = = = = = = = - - : : . |
108+
| . . : : - - - = = = = = = = = = - - - : : . |
109+
|0. . : : - - - = = = = = = = = = - - : : : . |
110+
| . . : : - - = = = = = = = = = - - : : . . |
111+
| . . : : - - - = = = = = = = = = - - : : : . |
112+
| . . : : - - - = = = = = = = = = - - - : : . |
113+
| . . . : : - - = = = = = = = = = = = - - : : . |
114+
| . . . : - - - = = = = = + = = = = = - - : : . . |
115+
|-1.00 |
116+
| . . : : - - = = = + + + + + + + = = = - - : : . |
117+
| . . : - - = = = + + + + + + + + + = = = - - : . . |
118+
| . : : - = = = + + + + + * + + + + + = = = - : : . |
119+
| . : - - = = + + + * * * * * * * + + + = = - - : . |
120+
| : - - = + + + * * * * * # * * * * * + + + = - - : |
121+
|-2.00 = + + * * * # # # # # # # # # * * * + + = - - |
122+
| - = + + * * # # # % % % % % % % # # # * * + + = - |
123+
| = + +. * .# . # .# % % %. %. %. @ .% % .% % %. #. # . * .* .+ + = |
124+
| -2.00 -1.00 0 1.00 2.00 |
125+
+--------------------------------------------------------------------------------+
126+
x
127+
y
128+
```
129+
130+
[Download PDF](../../media/examples/colored_contours/saddle_plasma.pdf)
131+
132+
### Ripple Function with Jet Colormap
133+
134+
![ripple_jet.png](../../media/examples/colored_contours/ripple_jet.png)
135+
136+
ASCII output:
137+
```
138+
139+
Ripple Function - Jet Colormap
140+
+--------------------------------------------------------------------------------+
141+
|2.00 |
142+
| + * * * + = = - - : : - - = = + * * * + |
143+
| |
144+
|1*50 * * + = - : . . . . . . : - = + * * * |
145+
| * * + - : . . : - + * * |
146+
| . |
147+
| * + - : . . : - + * |
148+
|1+00 = : . . . : : . . . : = + |
149+
| . |
150+
| = - . . - = + + = - . . - = |
151+
|.500 : . - + # # # # + - . : = |
152+
| - . . - + # % % % % # + - . . - |
153+
| |
154+
| - . . = # % @ % % @ % # = . . - |
155+
|0: . : + # % % * * % % # + : . : |
156+
| |
157+
| : . : + # % % * * % % # + : . : |
158+
| - . . = # % @ % % @ % # = . . - |
159+
|-.500 |
160+
| - . . - + # % % % % # + - . . - |
161+
| = : . - + # # # # + - . : = |
162+
| = - . . - = + + = - . . - = |
163+
|-1.00 |
164+
| + = : . . . : : . . . : = + |
165+
| * + - : . . : - + * |
166+
|-1.50 |
167+
| * * + - : . . : - + * * |
168+
| * * * + = - : . . . . . . : - = + * * * |
169+
| + * *. *. + . = . = .- .- : : -. -. = . = . + .* .* * + |
170+
|-2.00 -1.50 -1.00 -.500 0 .500 1.00 1.50 2.00 |
171+
+--------------------------------------------------------------------------------+
172+
x
173+
y
174+
```
175+
176+
[Download PDF](../../media/examples/colored_contours/ripple_jet.pdf)
177+
178+
### Ripple Function with Coolwarm Colormap
179+
180+
![ripple_coolwarm.png](../../media/examples/colored_contours/ripple_coolwarm.png)
181+
182+
ASCII output:
183+
```
184+
185+
Ripple Function - Coolwarm Colormap
186+
+--------------------------------------------------------------------------------+
187+
|2.00 |
188+
| + * * * + = = - - : : - - = = + * * * + |
189+
| |
190+
|1*50 * * + = - : . . . . . . : - = + * * * |
191+
| * * + - : . . : - + * * |
192+
| . |
193+
| * + - : . . : - + * |
194+
|1+00 = : . . . : : . . . : = + |
195+
| . |
196+
| = - . . - = + + = - . . - = |
197+
|.500 : . - + # # # # + - . : = |
198+
| - . . - + # % % % % # + - . . - |
199+
| |
200+
| - . . = # % @ % % @ % # = . . - |
201+
|0: . : + # % % * * % % # + : . : |
202+
| |
203+
| : . : + # % % * * % % # + : . : |
204+
| - . . = # % @ % % @ % # = . . - |
205+
|-.500 |
206+
| - . . - + # % % % % # + - . . - |
207+
| = : . - + # # # # + - . : = |
208+
| = - . . - = + + = - . . - = |
209+
|-1.00 |
210+
| + = : . . . : : . . . : = + |
211+
| * + - : . . : - + * |
212+
|-1.50 |
213+
| * * + - : . . : - + * * |
214+
| * * * + = - : . . . . . . : - = + * * * |
215+
| + * *. *. + . = . = .- .- : : -. -. = . = . + .* .* * + |
216+
|-2.00 -1.50 -1.00 -.500 0 .500 1.00 1.50 2.00 |
217+
+--------------------------------------------------------------------------------+
218+
x
219+
y
220+
```
221+
222+
[Download PDF](../../media/examples/colored_contours/ripple_coolwarm.pdf)
223+
224+
### Ripple Function with Inferno Colormap
225+
226+
![ripple_inferno.png](../../media/examples/colored_contours/ripple_inferno.png)
227+
228+
ASCII output:
229+
```
230+
231+
Ripple Function - Inferno Colormap
232+
+--------------------------------------------------------------------------------+
233+
|2.00 |
234+
| + * * * + = = - - : : - - = = + * * * + |
235+
| |
236+
|1*50 * * + = - : . . . . . . : - = + * * * |
237+
| * * + - : . . : - + * * |
238+
| . |
239+
| * + - : . . : - + * |
240+
|1+00 = : . . . : : . . . : = + |
241+
| . |
242+
| = - . . - = + + = - . . - = |
243+
|.500 : . - + # # # # + - . : = |
244+
| - . . - + # % % % % # + - . . - |
245+
| |
246+
| - . . = # % @ % % @ % # = . . - |
247+
|0: . : + # % % * * % % # + : . : |
248+
| |
249+
| : . : + # % % * * % % # + : . : |
250+
| - . . = # % @ % % @ % # = . . - |
251+
|-.500 |
252+
| - . . - + # % % % % # + - . . - |
253+
| = : . - + # # # # + - . : = |
254+
| = - . . - = + + = - . . - = |
255+
|-1.00 |
256+
| + = : . . . : : . . . : = + |
257+
| * + - : . . : - + * |
258+
|-1.50 |
259+
| * * + - : . . : - + * * |
260+
| * * * + = - : . . . . . . : - = + * * * |
261+
| + * *. *. + . = . = .- .- : : -. -. = . = . + .* .* * + |
262+
|-2.00 -1.50 -1.00 -.500 0 .500 1.00 1.50 2.00 |
263+
+--------------------------------------------------------------------------------+
264+
x
265+
y
266+
```
267+
268+
[Download PDF](../../media/examples/colored_contours/ripple_inferno.pdf)
269+

‎doc/media/examples/colored_contours/gaussian_default.pdf‎

2.06 KB
Binary file not shown.

‎doc/media/examples/colored_contours/gaussian_default.png‎

19 KB
Loading

‎doc/media/examples/colored_contours/ripple_coolwarm.pdf‎

32.1 KB
Binary file not shown.

‎doc/media/examples/colored_contours/ripple_coolwarm.png‎

101 KB
Loading

‎doc/media/examples/colored_contours/ripple_inferno.pdf‎

32.1 KB
Binary file not shown.

‎doc/media/examples/colored_contours/ripple_inferno.png‎

101 KB
Loading

‎doc/media/examples/colored_contours/ripple_jet.pdf‎

32.1 KB
Binary file not shown.

‎doc/media/examples/colored_contours/ripple_jet.png‎

101 KB
Loading

0 commit comments

Comments
 (0)