forked from mscroggs/symfem
-
Notifications
You must be signed in to change notification settings - Fork 0
/
update_readme.py
47 lines (38 loc) · 1.66 KB
/
update_readme.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
"""Script to update the list of available elements in README.md."""
import typing
import symfem
cells = ["interval", "triangle", "quadrilateral", "tetrahedron",
"hexahedron", "prism", "pyramid", "dual polygon"]
elementlist: typing.Dict[str, typing.List[str]] = {i: [] for i in cells}
for e in symfem.create._elementlist:
name = e.names[0]
if len(e.names) > 1:
name += " (alternative names: " + ", ".join(e.names[1:]) + ")"
for r in e.references:
elementlist[r].append(name)
for j in elementlist.values():
j.sort(key=lambda x: x.lower())
with open("README.md") as f:
pre = f.read().split("# Available cells and elements")[0]
with open("README.md", "w") as f:
f.write(pre)
f.write("# Available cells and elements\n")
for cell in cells:
f.write(f"## {cell[0].upper()}{cell[1:]}\n")
if cell == "dual polygon":
f.write(f"The reference {cell} (hexagon example shown) has vertices ")
ref = symfem.create_reference("dual polygon(6)")
else:
f.write(f"The reference {cell} has vertices ")
ref = symfem.create_reference(cell)
str_v = [f"{v}" for v in ref.vertices]
if len(ref.vertices) <= 2:
f.write(" and ".join(str_v))
else:
f.write(", and ".join([", ".join(str_v[:-1]), str_v[-1]]))
f.write(". Its sub-entities are numbered as follows.\n\n")
f.write(f"![The numbering of a reference {cell}]"
f"(img/{cell.replace(' ', '_')}_numbering.png)\n\n")
f.write("### List of supported elements\n")
f.write("\n".join([f"- {i}" for i in elementlist[cell]]))
f.write("\n\n")