User Tools
Differences
This shows you the differences between two versions of the page.
| — |
old_home [2018/01/29 12:25] (current) ndrs created |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Welcome to DesignSPHysics wiki. ====== | ||
| + | == This wiki is currently under construction and probably outdated! == | ||
| + | |||
| + | This page is a reference for using DesignSPHysics. | ||
| + | |||
| + | Quick link to Sections: | ||
| + | - [[installation|Installation]] | ||
| + | - [[featreference|Feature Reference]] | ||
| + | - [[concepts|Concepts and clarifications]] | ||
| + | ===== General information ===== | ||
| + | DesignSPHysics is a FreeCAD macro that allows the user to create simulation cases for the fluid simulation software DesignSPHysics. | ||
| + | |||
| + | It can create 3D and 2D scenes delimited by a cube or a plane (limits of case simulation) with all of FreeCAD's functionalities. DesignSPHysics exports the scene in a compatible XML file, with any data needed for GenCase execution included in the save directory. Also, it can load previously saved scenes for further edition. | ||
| + | |||
| + | It supports creating bounds and fluids, floating objects, fillboxes, etc. All from one place. | ||
| + | |||
| + | In addition, DesignSPHysics generates batch scripts for simulating saved cases, so it is portable and not necessary for simulation (for example, taking the simulation to a non-GUI environment). | ||
| + | |||
| + | However, if you want, DesignSPHysics can run simulations and execute post-processing tools from FreeCAD, automating multiple steps and providing a graphical view of the process. | ||
| + | |||
| + | Currently, DesignSPHysics is free to use and can be downloaded from the [[http://design.sphysics.org/ | official website]]. | ||
| + | |||
| + | ===== Installing ===== | ||
| + | Installing DesignSPHysics is pretty straightforward, but if you have any problem, check the [[Installation|Installation]] wiki page. | ||
| + | |||
| + | ===== How to use ===== | ||
| + | You can check the [[featreference|Feature Reference]] wiki page to learn how the use this software. | ||
| + | |||
| + | If this is also your first time with DualSPHysics (or even with an SPH solver), please also check out the [[concepts|Concepts and clarifications]] section, that explains some things that may seem difficult to understand. | ||
| + | |||
| + | ===== Development and technical info ===== | ||
| + | At 22 of June 2017 the development of DesignSPHysics is driven mainly by Andrés Vieira at EPhysLab. | ||
| + | |||
| + | DesignSPHysics is a //Macro// for the parametric 3D modeler //FreeCAD//. Its entirely made in Python 2.7 (with bits of Bash scripting and HTML/CSS for templates) and its meant to be self contained and multiplatform. | ||
| + | |||
| + | This software is tied up to the DualSPHysics suite, as a large part of its functionality is aided with GenCase, DualSPHysics and several post-processing tools. | ||
| + | |||
| + | If you want to contribute to the project or help out finding issues or suggestions, the right way to go is [[https://github.com/ndrs92/DesignSPHysics|DesignSPHysics' GitHub repo]]. Any help is welcome :) | ||
| + | |||
| + | ===== Reporting errors and making suggestions ===== | ||
| + | To report errors and make suggestions you have several ways to do it. The best way to do it is to post an issue in the [[https://github.com/ndrs92/DesignSPHysics/issues|GitHub repository]] (you will need an account), as it is automatically notified into my email and integrated with the version control system. | ||
| + | |||
| + | You can also send an email to [[mailto:anvieiravazquez@gmail.com|anvieiravazquez@gmail.com]] or [[mailto:anvieiravazquez@gmail.com|avieira@uvigo.es]] | ||
| + | |||
| + | If it is a suggestion or an interface error (easy to see) you can only send details of the error or suggestion, and if you want an can, provide some screenshots. | ||
| + | |||
| + | If it is an unknown error (something that should happen but do not, for example), please open the Report View inside FreeCAD. To open it, check the option View -> Panels -> Report View | ||
| + | |||
| + | In the Report view that appears should be a red text with errors. Please send a copy of that (or even an screenshot). | ||
| + | |||
| + | Don't forget to specify in detail all that you did to encounter the error or in the case of a suggestions, all the details of the suggested feature, patch or fix. | ||
| + | |||
| + | Thanks for contributing! | ||
| + | |||
| + | ===== License ===== | ||
| + | Copyright (C) 2017 - Andrés Vieira (anvieiravazquez@gmail.com) | ||
| + | EPHYSLAB Environmental Physics Laboratory, Universidade de Vigo | ||
| + | EPHYTECH Environmental Physics Technologies | ||
| + | |||
| + | DesignSPHysics is free software: you can redistribute it and/or modify | ||
| + | it under the terms of the GNU General Public License as published by | ||
| + | the Free Software Foundation, either version 3 of the License, or | ||
| + | (at your option) any later version. | ||
| + | |||
| + | DesignSPHysics is distributed in the hope that it will be useful, | ||
| + | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| + | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| + | GNU General Public License for more details. | ||
| + | |||
| + | You should have received a copy of the GNU General Public License | ||
| + | along with DesignSPHysics. If not, see <http://www.gnu.org/licenses/>. | ||
