Skip to content

Commit

Permalink
Fix documentation (error from diagram)
Browse files Browse the repository at this point in the history
  • Loading branch information
VEZY committed May 15, 2024
1 parent 6d304b5 commit 2c3f6d2
Show file tree
Hide file tree
Showing 13 changed files with 1,111 additions and 623 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ The package is designed around [MultiScaleTreeGraph](https://github.com/VEZY/Mul

The package provides different functionalities, the main ones being:

- IO for the OPF file format (see [`read_opf`](@ref) and [`write_opf`](@ref));
- plotting using [`viz`](@ref) and [`viz!`](@ref), optionally using coloring by attribute;
- mesh transformations using [`transform_mesh!`](@ref)
- IO for the OPF file format (see `read_opf` and `write_opf`);
- plotting using `viz` and `viz!`, optionally using coloring by attribute;
- mesh transformations using `transform_mesh!`

Note that `:geometry` is a reserved attribute in nodes (*e.g.* organs) used for the 3D geometry. It is stored as a special structure ([`geometry`](@ref)).
Note that `:geometry` is a reserved attribute in nodes (*e.g.* organs) used for the 3D geometry. It is stored as a special structure (`geometry`).

## Example usage

Expand Down
Loading

0 comments on commit 2c3f6d2

Please sign in to comment.