Skip to content

Commit

Permalink
Markdown files updated, following the latest merge
Browse files Browse the repository at this point in the history
  • Loading branch information
vmagnin committed Feb 20, 2024
1 parent 4c4a923 commit 91a4037
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 7 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ All notable changes to the gtk-fortran project are documented in this file. The
## [forcolormap dev]

### Added
* A FORD documentation with a CI workflow, generating https://vmagnin.github.io/forcolormap/
* Methods `create_lagrange()` and `create_bezier()` in `src/colormap_class.f90` to create a colormap from continuous interpolation of control colors.
* `example/create.f90` demonstrates creating a custom colormap using methods like `create_lagrange()` and `create_bezier()`.
* A `reverse()` method to reverse a colormap.
* A `shift()` method to apply a circular shift to a colormap (left is +, right is -).
* `example/modify.f90` demonstrates how you can modify a colormap with methods like shift(), in concrete cases.
* A private `check()` method in the Colormap class. It checks the validity of the colormap and its parameters, prints warnings, and fixes problems if necessary.
* A `colormaps_list/ForColormap.pdf` manual listing all the available colormaps.
* A function `bezier(colors, levels)` to create a colormap from continuous Bezier interpolation of control colors, in `src/colormap_class.f90`. The corresponding demo was added in `example/demo.f90`.
* A link toward the page *ForColormap Collection Categories* was added in the `README.md` to help users choose a colormap.
* A GitHub workflow for the CMake build by @jchristopherson.
* CMake support by @jchristopherson.
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ In the `example` directory, you will find these commented demos:
* `demo_reverse.f90` demonstrates the usage of the `reverse=.true.` option to reverse the direction of a colormap.
* `colormaps_list.f90` generates the `colormaps_list/COLORMAPS_LIST_*.md` files.
* `example1.f90` demonstrates how ForImage can be used to import/export PPM files.
* `create.f90` demonstrates creating a custom colormap using methods like `create_lagrange()` and `create_bezier()`.
* `extract.f90` demonstrates how to create a specific colormap by extracting a specified number of colors of a colormap.
* `info.f90` demonstrates how to obtain information about a colormap using the `Colormaps_info` class.
* `modify.f90` demonstrates how you can modify a colormap with methods like `shift()`, in concrete cases.
Expand Down
10 changes: 5 additions & 5 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ The main goal of v0.9 is to offer a usable library, sufficiently friendly, with
- [ ] Test with gtk-fortran and other libraries.
- [x] Introspection (Colormap_info)
- [x] Include all available colormaps.
- [ ] Add Interpolation functions.
- [ ] Lagrange
- [x] Add Interpolation functions.
- [x] Lagrange
- [x] Bezier
- [ ] Add a `Colormap_test` class where the subroutine `test_colormap()` will be moved.
- [ ] Add a `colormap_utils.f90` module where the subroutine `test_colormap()` will be moved.

### Examples

Expand All @@ -27,12 +27,12 @@ The main goal of v0.9 is to offer a usable library, sufficiently friendly, with

- [x] Develop a PDF guide with all colorbars to aid in choosing a colormap.
- [x] Develop a web version guide with all colorbars to aid in choosing a colormap.
- [ ] Create a simple documentation generated with FORD.
- [x] Create a simple documentation generated with FORD.

### Continuous Integration (CI)

- [ ] Integrate fpm tests.
- [ ] Integrate FORD documentation.
- [x] Integrate FORD documentation.

### Building System

Expand Down
3 changes: 2 additions & 1 deletion example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

They can be launched with the command `fpm run --example name_of_the_example` (without the `.f90` extension):

* `demo.f90` creates demo PPM files for each built-in colormap, plus a PPM file with the corresponding colorbars. It also demonstrates how to create your own colormap defined in an array, how to download a colormap from a `.txt` file, and how to create a colormap from continuous Bezier interpolation of control colors.
* `demo.f90` creates demo PPM files for each built-in colormap, plus a PPM file with the corresponding colorbars. It also demonstrates how to create your own colormap defined in an array, how to download a colormap from a `.txt` file.
* `demo_reverse.f90` demonstrates the usage of the `reverse=.true.` option to reverse the direction of a colormap.
* `example1.f90` demonstrates how ForImage can be used to import/export PPM files.
* `create.f90` demonstrates creating a custom colormap using methods like `create_lagrange()` and `create_bezier()`.
* `extract.f90` demonstrates how to create a specific colormap by extracting a specified number of colors of a colormap.
* `info.f90` demonstrates how to obtain information about a colormap using the `Colormaps_info` class.
* `modify.f90` demonstrates how you can modify a colormap with methods like shift(), in concrete cases.

0 comments on commit 91a4037

Please sign in to comment.