Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxBoehler committed Mar 25, 2020
0 parents commit c7324ee
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# ARTSS
Accelerated Based Real Time Smoke Simulation

ARTSS is a real-time and prognosis capable CFD code basis simulating buoyancy-driven turbulent smoke spread
based on finite differences and a large eddy simulation turbulence model, being performance portable on CPU
and GPU contained in one expandable, open source code, successfully verified using unit, analytical and
semi-analytical tests, and successfully validated with scenarios relevant for fire protection.

## Getting Started

### Requirements
The serial CPU version of ARTSS can be compiled on Linux or OS X systems with very few tools,
whereas the multicore and GPU version need an OpenACC capable compiler.
Detailed requirements are listed in the table below (general requirements for serial version, specific for multicore and GPU version).

| | Purpose | Tool | Version |
|--------- | --------------------------------------------------- | -------- | --------------|
| General | Version control system to obtain the source code | git | >= 2.0 |
| | Build processor using a compiler-independent method | CMake | >= 2.8 |
| | Compiler fully supporting C++-11 | gcc | >= 4.7 |
| | | clang | >= 6.1 |
| | Visualization of output | vtk | >= 5.8 |
| | | Paraview/| VisIT |
| | Testing for consistency of output while developing | python | >= 2.7 |
| Specific | Compiler fully supporting C++-11 and OpenACC | PGI | >=17.3/17.4 |
| | Profiling (using NVTX) | CUDA | >= 8.0 |

0 comments on commit c7324ee

Please sign in to comment.