Skip to content

Commit dfebd69

Browse files
committed
typo fixes
1 parent b51e195 commit dfebd69

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
CadQuery plugin to create a mesh of an assembly with corresponding data.
44

5-
This plugin makes use of CadQuery tags to collect surfaces into Gmsh physical groups. The
5+
This plugin makes use of CadQuery tags to collect surfaces into [Gmsh](https://gmsh.info/) physical groups. The
66
tagged faces are matched to their corresponding surfaces in the mesh via their position in the CadQuery solid(s) vs the Gmsh surface ID. There are a few challenges with mapping tags to surfaces to be aware of.
77

88
1. Each tag can select multiple faces/surfaces at once, and this has to be accounted for when mapping tags to surfaces.
@@ -23,7 +23,7 @@ The plugin needs to be imported in order to monkey-patch its method into CadQuer
2323
import assembly_mesh_plugin.plugin
2424
```
2525

26-
You can then tag faces in each of the assembly parts and create your asembly. To export the assembly to a mesh file, you do the following.
26+
You can then tag faces in each of the assembly parts and create your assembly. To export the assembly to a mesh file, you do the following.
2727

2828
```python
2929
your_assembly.assemblyToGmsh(mesh_path="tagged_mesh.msh")
@@ -63,7 +63,7 @@ The resulting `.msh` file should have three physical groups named for tags in it
6363

6464
These tests are also run in Github Actions, and the meshes which are generated can be viewed as artifacts on the successful `tests` Actions there.
6565

66-
* [sample_coils.py](tests/sample_coils.py) contains generators for sample assemlies for use in testing the basic operation of this plugin. This file also contains the code to tag all faces of interest.
66+
* [sample_coils.py](tests/sample_coils.py) contains generators for sample assemblies for use in testing the basic operation of this plugin. This file also contains the code to tag all faces of interest.
6767
* [smoke_test.py](tests/smoke_test.py) runs two tests currently. The first is for a simple cross-section of a coil (image below), which makes it easier to verify basic operation. The second is for a planar coil, which forces the use of more advanced selectors, but is not as complex as a coil with a non-planar sweep path. This planar-coil test is not complete yet.
6868

6969
Once the test has been run (using the pytest command), two mesh files (.msh extension) be created in the root of the repository.

0 commit comments

Comments
 (0)