diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..53a0dba277ed7d0fd10ab03809dec8e617fbd2df --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Welcome to the Spindle FEA application repository + +[](https://opensource.org/licenses/MIT) +[](https://github.com/sb2g14/soton_roles/graphs/contributors) +[](https://github.com/sb2g14/soton_roles/issues) + +## Installation instructions + +1. The application requires Abaqus CAE to be installed. It can be acquired from here: https://www.3ds.com/products-services/simulia/products/abaqus/abaquscae +2. Clone or download this repository + +## Running the analysis + +1. The interactive documentation on the application with the step-by-step guide on how to run the application are located in ```/docs/build/html/index.html``` in this repository. +2. To run the somplest test you need to navigate to the root of this directory and execute ```Abaqus cae noGUI=job.py``` in the command line. +3. After the analysis has finished you will be able to open the ```Job-1.odb``` file in the Abaqus CAE graphical user interface. The detailed information about the analysis you can also find in ```Job-1.dat``` file. +4. For more advanced control of the application refer to the documentation. + +## License + +The [MIT license](http://opensource.org/licenses/MIT).