Update README.md

README.md

@@ -1,2 +1,34 @@
-# VectorField_Multiaxis
-Vector Field Based Volume Peeling for Multi-Axis Machining
+# Vector Field Based Volume Peeling for Multi-Axis Machining
+
+![Pipeline of the method](./Images/pipeline.jpg)
+
+## Abstract
+This paper presents an easy-to-control volume peeling method for multi-axis machining based on the computation taken on vector fields. The current scalar field based methods are not flexible and the vector-field based methods do not guarantee the satisfaction of the constraints in the final results. We first conduct an optimization formulation to compute an initial vector field that is well aligned with those anchor vectors specified by users according to different manufacturing requirements. The vector field is further optimized to be an irrotational field so that it can be completely realized by a scalar field's gradients. Iso-surfaces of the scalar field will be employed as the layers of working surfaces for multi-axis volume peeling in the rough machining. Algorithms are also developed to remove and process singularities of the fields. Our method has been tested on a variety of models and verified by physical experimental machining. 
+
+
+## Installation
+Please compile the code with QMake file “ShapeLab.pro”.
+
+Platform: Windows + Visual Studio + QT-plugin (tested version: VS2019 + QT5.12.3 + msvc2017_64)
+
+Installation Steps:
+- Install Visual Studio Extension plug-in (QT VS Tool) to open the *.pro file and generate the project
+- Set 'ShapeLab' as the start up project
+- Enable OpenMP to get best performace at: ShapeLab Property Pages -> Configuration Properties -> C/C++ -> Language -> Open MP Support -> Select 'Yes (/openmp)'
+- Open Console at: ShapeLab Property Pages -> Configuration Properties -> Linker -> System -> SubSystem -> Select 'Console (/SUBSYSTEM:CONSOLE)'
+- Install Intel oneAPI Math Kernel Library (oneMKL download) and enable it at: ShapeLab Property Pages -> Configuration Properties -> Intel Libraries for oneAPI -> Intel oneAPI Math Kernel Library (oneMKL) -> Use oneMKL -> Select 'Parallel'
+- And change the code generation method at: ShapeLab & QMeshLab & GLKLib Property Pages -> Configuration Properties -> C/C++ -> Code Generation -> Runtime Library -> Select 'Multi-threaded(/MT) for release configuration'. Note that this option will be 'Multi-threaded Debug (/MTd) for debug configuration.
+
+
+
+## Usage
+### Files Required:
+  - The .obj file of the model to be machined . Naming convention to be used: **\<name\>_modelSurf.obj**
+  - The .obj file for the convex hull of the model. Naming convention to be used: **\<name\>_convexHull.obj**
+  - .TET file of the removable volume (stock - model). This can generated by a boolean opearation on surface meshes followed by tetrahedralization using [TetGen](https://wias-berlin.de/software/index.jsp?id=TetGen&lang=1). Naming convention to be used: **\<name\>_materialSpace.tet**
+
+  The location of all of the above files is to be in the folder **DataSet/TET_MODEL**
+
+### Usage Steps
+`Read Data` -> `Initialise Meshes` -> `Initialise Vector Field` -> `Propagate Field` -> `Generate Scalar Field` -> `IsoLayer Generation`
+