Skip to content

Commit f96de5f

Browse files
committed
Update README with better description
1 parent c797941 commit f96de5f

File tree

1 file changed

+5
-64
lines changed

1 file changed

+5
-64
lines changed

README.md

Lines changed: 5 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,8 @@
11
# HemiPlots.jl
22

3-
**HemiPlots.jl** is a Julia package for plotting hemispherical projection
4-
using Makie.
3+
HemiPlots.jl is a plotting package for visualizing three-dimensional
4+
orientation data on two-dimensional nets using Makie.
55

6-
It provides fast, flexible visualization of planes, lines, small circles,
7-
and daylight envelopes under arbitrary viewing directions.
8-
9-
> HemiPlots is a plotting-only package, etc...
10-
11-
---
12-
13-
## Installation
14-
] add HemiPlots
15-
16-
## Basic usage
17-
18-
using HemiPlots
19-
using GLMakie
20-
21-
## Create a stereonet:
22-
23-
h = hemi(net = :wulff, view = (0, 90))
24-
display(h)
25-
26-
## Plot planes
27-
28-
lines!(h, 120, 45) # plane trace
29-
lines!(h, 120, 45, view = :pole) # pole to plane
30-
31-
Multiple planes:
32-
33-
lines!(h, [30, 60, 90], [40, 50, 60])
34-
35-
## Plot lineations
36-
37-
scatter!(h, 45, 30)
38-
scatter!(h, [10, 40], [20, 60])
39-
40-
## Small circles
41-
42-
smallc!(h, 0, 0, 30)
43-
smallc!(h, [0, 90], [0, 0], [20, 40])
44-
45-
Filled small circles
46-
47-
smallc!(h, 0, 0, 30, draw = :poly)
48-
49-
## Datlight envelopes
50-
51-
daylight!(h, 90, 45)
52-
daylight!(h, 90, 45, draw = :poly)
53-
54-
Filled small circles
55-
56-
Explicar...
57-
58-
## Saving figures
59-
60-
save("stereonet.png", h)
61-
save("stereonet.pdf", h) # requires CairoMakie
62-
63-
esxplicar los detalles
64-
65-
## Citation
66-
67-
como se hace la cita de una repo github
6+
It provides methods to visualize planar, linear features, and
7+
small circles on equal-angle (Wulff) and equal-area (Schmidt) nets,
8+
with support for arbitrary viewing directions.

0 commit comments

Comments
 (0)