Skip to content

Commit 453d104

Browse files
author
chmerdon
committed
improved readme: fixed solve call, added unicode plot, added remark about running examples from the documentation
1 parent eff64ad commit 453d104

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,22 @@ assign_operator!(PD, HomogeneousBoundaryData(u; regions = 1:4))
4949
FEType = H1Pk{1,2,3} # cubic H1-conforming element with 1 component in 2D
5050
FES = FESpace{FEType}(xgrid)
5151

52-
# Solve the problem
53-
sol = solve!(PD, [FES])
52+
# Solve the problem + unicode plot into terminal
53+
sol = solve(PD, [FES]; plot = true, timeroutputs = :hide)
5454

5555
# Plot the solution
5656
using PyPlot
5757
plot(id(u), sol; Plotter = PyPlot)
5858
```
5959

60+
## Running examples from documentation
61+
62+
In the [documentation](https://wias-pdelib.github.io/ExtendableFEM.jl/stable/index.html) many more examples can be found.
63+
Each of the is written as a module that needs to be included first. Afterwards the main file of this module must be started.
64+
Usually the main functions have a Plotter argument that can be used to plot the solution with the backend of your
65+
choice (e.g. PyPlot, GLMakie, Plots or other supported by [GridVisualize.jl](https://github.com/WIAS-PDELib/GridVisualize.jl))
66+
67+
6068
## Citing
6169

6270
If you use ExtendableFEM.jl in your research, please cite [this Zenodo record](https://zenodo.org/doi/10.5281/zenodo.10563834).

0 commit comments

Comments
 (0)