Skip to content

Commit 5ce1bd7

Browse files
committed
added tutorial 3 to the documentation
1 parent f4c8348 commit 5ce1bd7

File tree

8 files changed

+443
-19
lines changed

8 files changed

+443
-19
lines changed
29.1 KB
Loading
27.3 KB
Loading
14.8 KB
Loading

docs/source/_tutorials/tutorial3unv.html

Lines changed: 387 additions & 0 deletions
Large diffs are not rendered by default.

docs/source/contributing.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
How to contribute
2+
===================
3+
4+
We'd love to accept your patches and contributions to this project. There are
5+
just a few small guidelines you need to follow.
6+
7+
Submitting a patch:
8+
9+
1. It's generally best to start by opening a new issue describing the bug or
10+
feature you're intending to fix. Even if you think it's relatively minor,
11+
it's helpful to know what people are working on. Mention in the initial
12+
issue that you are planning to work on that bug or feature so that it can
13+
be assigned to you.
14+
15+
2. Follow the normal process of forking the project, and setup a new
16+
branch to work in. It's important that each group of changes be done in
17+
separate branches in order to ensure that a pull request only includes the
18+
commits related to that bug or feature.
19+
20+
3. To ensure properly formatted code, please make sure to use a tab of 4
21+
spaces to indent the code. You should also run pylint over your code.
22+
It's not strictly necessary that your code be completely "lint-free",
23+
but this will help you find common style issues.
24+
25+
4. Any significant changes should almost always be accompanied by tests. The
26+
project already has good test coverage, so look at some of the existing
27+
tests if you're unsure how to go about it. We're using coveralls that
28+
is an invaluable tools for seeing which parts of your code aren't being
29+
exercised by your tests.
30+
31+
5. Do your best to have well-formed commit messages for each change.
32+
This provides consistency throughout the project, and ensures that commit
33+
messages are able to be formatted properly by various git tools.
34+
35+
6. Finally, push the commits to your fork and submit a pull request. Please,
36+
remember to rebase properly in order to maintain a clean, linear git history.

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ Tutorials
3939
We made some tutorial examples:
4040

4141
- `Tutorial 1 <tutorial1stl.html>`_ shows how to deal with stl files
42-
- `Turorial 2 <tutorial2iges.html>`_ show how to deal with iges files
42+
- `Turorial 2 <tutorial2iges.html>`_ shows how to deal with iges files
43+
- `Turorial 3 <tutorial3unv.html>`_ shows how to deal with unv files and how to set the desired continuity to the geometry
4344

4445

4546

tutorials/tutorial-2-iges.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"cell_type": "markdown",
2626
"metadata": {},
2727
"source": [
28-
"First of all we just import pygem package, we set matplotlib for the notebook and we read a parameters file."
28+
"First of all we just import pygem package and we read a parameters file."
2929
]
3030
},
3131
{

tutorials/tutorial-3-unv.ipynb

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"cell_type": "markdown",
1919
"metadata": {},
2020
"source": [
21-
"In this tutorial we show how to perform the Free Form Deformation on a hexaedral mesh of a cylinder. In particular, above what already seen in the previous tutorials, we give some information about how set the continuity we want to the geometry we are morphing.\n",
21+
"In this tutorial we show how to perform the Free Form Deformation on a hexaedral mesh of a cylinder. In particular, above what already seen in the previous tutorials, we give some information about how to set the desired continuity to the geometry we are morphing.\n",
2222
"\n",
2323
"First of all we just import pygem package and we read a parameters file."
2424
]
@@ -58,18 +58,18 @@
5858
"n control points y: 2 \n",
5959
"n control points z: 3 \n",
6060
" \n",
61-
"box lenght x: 2.2\n",
62-
"box lenght y: 2.2\n",
63-
"box lenght z: 6.0 \n",
64-
"\n",
65-
"box origin x: -1.1\n",
66-
"box origin y: -1.1\n",
67-
"box origin z: 2.0\n",
68-
"\n",
61+
"box lenght x: 2.2 \n",
62+
"box lenght y: 2.2 \n",
63+
"box lenght z: 6.0 \n",
6964
"\n",
65+
"box origin x: -1.1 \n",
66+
"box origin y: -1.1 \n",
67+
"box origin z: 2.0 \n",
68+
" \n",
69+
" \n",
7070
"[Parameters weights] \n",
7171
"\n",
72-
"parameter x: \n",
72+
"parameter x: \n",
7373
"\n",
7474
" 0 0 1 0.8\n",
7575
" 0 1 1 0.8\n",
@@ -150,13 +150,13 @@
150150
"n control points y: 2 \n",
151151
"n control points z: 5 \n",
152152
" \n",
153-
"box lenght x: 2.2\n",
154-
"box lenght y: 2.2\n",
155-
"box lenght z: 6.0 \n",
153+
"box lenght x: 2.2 \n",
154+
"box lenght y: 2.2 \n",
155+
"box lenght z: 6.0 \n",
156156
"\n",
157-
"box origin x: -1.1\n",
158-
"box origin y: -1.1\n",
159-
"box origin z: 2.0\n",
157+
"box origin x: -1.1 \n",
158+
"box origin y: -1.1 \n",
159+
"box origin z: 2.0 \n",
160160
"\n",
161161
"\n",
162162
"[Parameters weights] \n",
@@ -222,7 +222,7 @@
222222
"name": "python",
223223
"nbconvert_exporter": "python",
224224
"pygments_lexer": "ipython2",
225-
"version": "2.7.6"
225+
"version": "2.7.10"
226226
}
227227
},
228228
"nbformat": 4,

0 commit comments

Comments
 (0)