Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
387 changes: 387 additions & 0 deletions docs/source/_tutorials/tutorial3unv.html

Large diffs are not rendered by default.

36 changes: 36 additions & 0 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
How to contribute
===================

We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

Submitting a patch:

1. It's generally best to start by opening a new issue describing the bug or
feature you're intending to fix. Even if you think it's relatively minor,
it's helpful to know what people are working on. Mention in the initial
issue that you are planning to work on that bug or feature so that it can
be assigned to you.

2. Follow the normal process of forking the project, and setup a new
branch to work in. It's important that each group of changes be done in
separate branches in order to ensure that a pull request only includes the
commits related to that bug or feature.

3. To ensure properly formatted code, please make sure to use a tab of 4
spaces to indent the code. You should also run pylint over your code.
It's not strictly necessary that your code be completely "lint-free",
but this will help you find common style issues.

4. Any significant changes should almost always be accompanied by tests. The
project already has good test coverage, so look at some of the existing
tests if you're unsure how to go about it. We're using coveralls that
is an invaluable tools for seeing which parts of your code aren't being
exercised by your tests.

5. Do your best to have well-formed commit messages for each change.
This provides consistency throughout the project, and ensures that commit
messages are able to be formatted properly by various git tools.

6. Finally, push the commits to your fork and submit a pull request. Please,
remember to rebase properly in order to maintain a clean, linear git history.
3 changes: 2 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ Tutorials
We made some tutorial examples:

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



Expand Down
2 changes: 1 addition & 1 deletion tutorials/tutorial-2-iges.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"First of all we just import pygem package, we set matplotlib for the notebook and we read a parameters file."
"First of all we just import pygem package and we read a parameters file."
]
},
{
Expand Down
34 changes: 17 additions & 17 deletions tutorials/tutorial-3-unv.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"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",
"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",
"\n",
"First of all we just import pygem package and we read a parameters file."
]
Expand Down Expand Up @@ -58,18 +58,18 @@
"n control points y: 2 \n",
"n control points z: 3 \n",
" \n",
"box lenght x: 2.2\n",
"box lenght y: 2.2\n",
"box lenght z: 6.0 \n",
"\n",
"box origin x: -1.1\n",
"box origin y: -1.1\n",
"box origin z: 2.0\n",
"\n",
"box lenght x: 2.2 \n",
"box lenght y: 2.2 \n",
"box lenght z: 6.0 \n",
"\n",
"box origin x: -1.1 \n",
"box origin y: -1.1 \n",
"box origin z: 2.0 \n",
" \n",
" \n",
"[Parameters weights] \n",
"\n",
"parameter x: \n",
"parameter x: \n",
"\n",
" 0 0 1 0.8\n",
" 0 1 1 0.8\n",
Expand Down Expand Up @@ -150,13 +150,13 @@
"n control points y: 2 \n",
"n control points z: 5 \n",
" \n",
"box lenght x: 2.2\n",
"box lenght y: 2.2\n",
"box lenght z: 6.0 \n",
"box lenght x: 2.2 \n",
"box lenght y: 2.2 \n",
"box lenght z: 6.0 \n",
"\n",
"box origin x: -1.1\n",
"box origin y: -1.1\n",
"box origin z: 2.0\n",
"box origin x: -1.1 \n",
"box origin y: -1.1 \n",
"box origin z: 2.0 \n",
"\n",
"\n",
"[Parameters weights] \n",
Expand Down Expand Up @@ -222,7 +222,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython2",
"version": "2.7.6"
"version": "2.7.10"
}
},
"nbformat": 4,
Expand Down