[asl] 05/27: Add explicit dependency

Sat Nov 26 16:35:42 UTC 2016

This is an automated email from the git hooks/post-receive script.

ghisvail-guest pushed a commit to branch debian/master
in repository asl.

commit ceb84498ee3490561873dc78a55b179a5d7a40b6
Author: Avtech Scientific <AvtechScientific at users.noreply.github.com>
Date:   Mon Nov 7 09:42:21 2016 +0200

    Add explicit dependency
---
 CMakeLists.txt |  4 ++--
 COPYRIGHT.md   | 38 --------------------------------------
 COPYRIGHT.org  | 38 ++++++++++++++++++++++++++++++++++++++
 NEWS.md        | 24 ------------------------
 NEWS.org       | 25 +++++++++++++++++++++++++
 README.md      | 58 ----------------------------------------------------------
 README.org     | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 119 insertions(+), 122 deletions(-)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6e449b2..db86565 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -53,7 +53,7 @@ find_package(OpenCL 1.1 REQUIRED)
 # ToDo: check - system component might be not needed any longer on new versions of Boost
 find_package(Boost 1.55 REQUIRED COMPONENTS program_options filesystem system)
 # ToDo: remove support for VTK 6.1 at some point in future
-find_package(VTK 6.1 QUIET COMPONENTS vtkRenderingCore vtkImagingCore vtkFiltersCore vtkIOCore vtkIOLegacy vtkIOXML vtkIOMINC vtkCommonCore vtkViewsCore vtkftgl vtksys vtkDICOMParser vtkexpat vtkzlib NO_MODULE)
+find_package(VTK 6.1 QUIET COMPONENTS vtkRenderingCore vtkImagingCore vtkFiltersCore vtkIOCore vtkIOGeometry vtkIOLegacy vtkIOXML vtkIOMINC vtkCommonCore vtkViewsCore vtkftgl vtksys vtkDICOMParser vtkexpat vtkzlib NO_MODULE)
 if(NOT VTK_FOUND)
 	find_package(VTK 7.0 REQUIRED COMPONENTS vtkRenderingCore vtkImagingCore vtkFiltersCore vtkIOCore vtkIOLegacy vtkIOXML vtkIOMINC vtkCommonCore vtkViewsCore vtksys vtkDICOMParser vtkexpat vtkzlib NO_MODULE)
 endif()
@@ -91,7 +91,7 @@ set(CPACK_PACKAGE_VERSION_MAJOR ${ASL_VERSION_MAJOR})
 set(CPACK_PACKAGE_VERSION_MINOR ${ASL_VERSION_MINOR})
 set(CPACK_PACKAGE_VERSION_PATCH ${ASL_VERSION_PATCH})
 set(CPACK_RESOURCE_FILE_LICENSE "${PROJECT_SOURCE_DIR}/LICENSE")
-set(CPACK_RESOURCE_FILE_README "${PROJECT_SOURCE_DIR}/README.md")
+set(CPACK_RESOURCE_FILE_README "${PROJECT_SOURCE_DIR}/README.org")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Advanced Simulation Library is a free and open source hardware accelerated multiphysics simulation platform.")
 set(CPACK_PACKAGE_DESCRIPTION "Advanced Simulation Library (ASL) is a free and open source hardware accelerated multiphysics simulation platform (and an extensible general purpose tool for solving Partial Differential Equations). Its computational engine is written in OpenCL and utilizes matrix-free solution techniques which enable extraordinarily high performance, memory efficiency and deployability on a variety of massively parallel architectures, ranging from inexpensive FPGAs, DSPs a [...]
 set(CPACK_PACKAGE_VENDOR "Avtech Scientific")
diff --git a/COPYRIGHT.md b/COPYRIGHT.md
deleted file mode 100644
index d717ed6..0000000
--- a/COPYRIGHT.md
+++ /dev/null
@@ -1,38 +0,0 @@
-# Copyright
-
-Advanced Simulation Library (ASL) <http://asl.org.il>
-
-Copyright 2015 Avtech Scientific <http://avtechscientific.com>
-
-ASL is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
-
-ASL 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 Affero General Public License for more details.
-
-You should have received a copy of the GNU Affero General Public License along with ASL. If not, see <http://www.gnu.org/licenses/>.
-
-All files, and specifically the images in `doc/Developer-Guide/pics` are part of the ASL project and are covered by its license except where stated otherwise (`cmake/Modules`).
-
-## Optional commercial license
-
-Optional [commercial license](http://asl.org.il/licensing) is available for closed-source ventures wishing to make a financial contribution to the development of ASL.
-
-## Author attributions
-
-If ASL is used for research that will be published or otherwise publicly distributed, we kindly ask that this fact is mentioned.
-
-The reference to ASL may be in an acknowledgment section, in a phrase such as the following:
-
-```
-"This work benefited from the use of the Advanced Simulation Library™ (ASL),
- an open source hardware accelerated multiphysics simulation platform developed
- by Avtech Scientific and available at <http://asl.org.il>."
-```
-
-To cite ASL in publications please adopt the following:
-
-_ASL: Advanced Simulation Library™, an open source hardware accelerated multiphysics simulation platform._[^1] Version 0.1.5.[^2] 2015-08-01.[^3] <http://asl.org.il>.[^4] Avtech Scientific. Modiin Illit, Israel.
-
-[^1]: Additionally any sub-routines that were used may be specified.  
-[^2]: Version number or commit hash (in the latter case write: Commit 794e49160c089c18a3b455e48bab6ad7c28bb685)  
-[^3]: Release or commit date.  
-[^4]: The URL should be an active hyperlink wherever technically possible.
\ No newline at end of file
diff --git a/COPYRIGHT.org b/COPYRIGHT.org
new file mode 100644
index 0000000..5fe5a2b
--- /dev/null
+++ b/COPYRIGHT.org
@@ -0,0 +1,38 @@
+* Copyright
+
+Advanced Simulation Library (ASL) [[http://asl.org.il]]
+
+Copyright 2015 Avtech Scientific [[http://avtechscientific.com]]
+
+ASL is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.
+
+ASL 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 Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with ASL. If not, see [[http://www.gnu.org/licenses/]].
+
+All files, and specifically the images in =doc/Developer-Guide/pics= are part of the ASL project and are covered by its license except where stated otherwise (=cmake/Modules=).
+
+** Optional commercial license
+
+Optional [[http://asl.org.il/licensing][commercial license]] is available for closed-source ventures wishing to make a financial contribution to the development of ASL.
+
+** Author attributions
+
+If ASL is used for research that will be published or otherwise publicly distributed, we kindly ask that this fact is mentioned.
+
+The reference to ASL may be in an acknowledgment section, in a phrase such as the following:
+
+#+BEGIN_EXAMPLE
+    "This work benefited from the use of the Advanced Simulation Library™ (ASL),
+     an open source hardware accelerated multiphysics simulation platform developed
+     by Avtech Scientific and available at <http://asl.org.il>."
+#+END_EXAMPLE
+
+To cite ASL in publications please adopt the following:
+
+/ASL: Advanced Simulation Library™, an open source hardware accelerated multiphysics simulation platform/.[1] Version 0.1.5.[2] 2015-08-01.[3] [[http://asl.org.il]].[4] Avtech Scientific. Modiin Illit, Israel.
+
+[1] Additionally any sub-routines that were used may be specified.
+[2] Version number or commit hash (in the latter case write: Commit 794e4916)
+[3] Release or commit date.
+[4] The URL should be an active hyperlink wherever technically possible.
diff --git a/NEWS.md b/NEWS.md
deleted file mode 100644
index 97a3335..0000000
--- a/NEWS.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# News and ChangeLog
-
-
-## 0.1.7
-
-- bug fixes
-- fixing portability issues
-
-Contributors: Bartłomiej Piotrowski, Evgeniy Alekseev.
-
-
-## 0.1.6
-
-- fixing linkage issues
-- fixing testing issues
-- fixing an installation bug
-
-
-## 0.1.5
-
-- supplying cl.hpp, since not provided by OpenCL 2.0 (causes harmless "deprecated" warnings)
-- bug fixes
-- improved tests
-- improved examples
diff --git a/NEWS.org b/NEWS.org
new file mode 100644
index 0000000..14f04e8
--- /dev/null
+++ b/NEWS.org
@@ -0,0 +1,25 @@
+* News and ChangeLog
+
+** 0.1.7
+
+- providing more accurate project description in README
+- adding missing default parameters for some examples
+- fixing VTK (7.0, 7.1) related linking issues
+- bug fixes
+- fixing portability issues
+
+Contributors: Bartłomiej Piotrowski, Evgeniy Alekseev, Orion Poplawski.
+
+** 0.1.6
+
+- fixing linkage issues
+- fixing testing issues
+- fixing an installation bug
+
+** 0.1.5
+
+- supplying cl.hpp, since not provided by OpenCL 2.0 (causes harmless "deprecated" warnings)
+- bug fixes
+- improved tests
+- improved examples
+
diff --git a/README.md b/README.md
deleted file mode 100644
index 91a496a..0000000
--- a/README.md
+++ /dev/null
@@ -1,58 +0,0 @@
-
-For more information, please visit <http://asl.org.il>.
-
-
-# ASL
-
-__Advanced Simulation Library (ASL)__ is a free and open source hardware accelerated multiphysics simulation software. Its computational engine is based, among others, on the [Lattice Boltzmann Methods](http://en.wikipedia.org/wiki/Lattice_Boltzmann_methods) and is written in [OpenCL](http://en.wikipedia.org/wiki/OpenCL) which enable [extraordinarily efficient deployment](http://asl.org.il/benchmarks) on a variety of massively parallel architectures, ranging from inexpensive FPGAs, DSPs  [...]
-
-
-## License
-
-ASL is distributed under the free GNU Affero General Public License (AGPLv3) with an optional [commercial license](http://asl.org.il/licensing).
-
-
-## Support
-
-Professional consulting, training and integration services are provided by [Avtech Scientific](http://avtechscientific.com), whose team created and continues to extend the library. The company offers [innovative R&D solutions](http://avtechscientific.com/services) and is involved in diverse academic and industrial [collaborative projects](http://avtechscientific.com/projects) dealing with complex multidisciplinary problems.
-
-
-## Quick Start
-
-### Installation
-
-1. Install [cmake](http://cmake.org) (>=3.0.2, BSD License) and the required libraries:
-	- [OpenCL](https://www.khronos.org/opencl) (>=1.2, OpenCL Specification License); [open](https://www.khronos.org/opencl/resources/opencl-open-source-opencl-implementations) or [closed source](https://www.khronos.org/opencl/resources/opencl-commercial-implementations) implementation, see [deployment information](https://github.com/AvtechScientific/ASL/wiki/Deployment)
-	- [boost](http://www.boost.org) (>=1.55, Boost Software License)
-	- [VTK](http://vtk.org) (>=6.1, BSD License)
-	- [optional](https://github.com/AvtechScientific/ASL/blob/master/cmake/ASLBuildOptions.cmake#L3): Matlab support with [matio](https://sourceforge.net/projects/matio) (>=1.5.2, BSD License)
-	- [optional](https://github.com/AvtechScientific/ASL/blob/master/cmake/ASLBuildOptions.cmake#L4): API documentation with [doxygen](http://doxygen.org) (preferably with [graphviz](http://www.graphviz.org))
-2. Download and extract the [ASL source code archive](https://github.com/AvtechScientific/ASL/releases/latest).
-3. Create a build directory: `mkdir build-asl && cd build-asl`
-4. Use [cmake generator](http://www.cmake.org/cmake/help/v3.2/manual/cmake-generators.7.html) to produce Makefiles: `cmake -G "Unix Makefiles" ../ASL` or project files for your IDE (Visual Studio, Xcode, Eclipse, etc.): `cmake -G "Visual Studio 10" ../ASL`
-5. Run make (as root if installing into default destination `/usr/local`): `make install`
-
-### Running an example
-
-1. Go to examples: `cd examples/flow/locomotive`
-2. Download geometry file [locomotive.stl](http://asl.org.il/input_data/locomotive.stl) from the [ASL input data page](http://asl.org.il/input_data).
-3. Run: `./asl-locomotive --input locomotive.stl`  
-Optionally: change parameters `./asl-locomotive --input locomotive.stl --dx 1 --dt 2` or write all of them into a file for later editing/reuse - `./asl-locomotive -g bigGrid.ini`. List all available options - `./asl-locomotive -h`.
-4. Post-processing: see [step by step example](https://github.com/AvtechScientific/ASL/wiki/User-Guide#post-processing) and [locomotive.pvsm](http://asl.org.il/input_data/locomotive.pvsm) - the ParaView state file.
-
-### Writing your own code using ASL
-
-1. Take a look on [examples](http://asl.org.il/doc/Developer-Guide/examples.html) and the [API documentation](http://asl.org.il/doc/Developer-Guide/), start with [examples/flow/locomotive.cc](http://asl.org.il/doc/Developer-Guide/locomotive_8cc-example.html)
-2. ASL installation supplies `ASL.pc` and `ASLConfig.cmake` files. To build your program using:
-
-- `pkg-config`: ``c++ `pkg-config --cflags --libs ASL` -std=c++11 -o flow flow.cc``
-- `cmake`: write a basic `CMakeLists.txt` file:
-
-```cmake
-project(locomotive)
-cmake_minimum_required(VERSION 3.0.2 FATAL_ERROR)
-find_package(ASL 0.1.4 CONFIG REQUIRED)
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
-add_executable(locomotive locomotive.cc)
-target_link_libraries(locomotive PRIVATE ASL::aslnum ASL::aslvtk ASL::asl)
-```
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..8e064ff
--- /dev/null
+++ b/README.org
@@ -0,0 +1,54 @@
+For more information, please visit [[http://asl.org.il]].
+
+* ASL
+
+*Advanced Simulation Library (ASL)* is a free and open source hardware accelerated multiphysics simulation platform (and an extensible general purpose tool for solving Partial Differential Equations). Its computational engine is written in [[http://en.wikipedia.org/wiki/OpenCL][OpenCL]] and utilizes matrix-free solution techniques which enable [[http://asl.org.il/benchmarks][extraordinarily high performance, memory efficiency and deployability]] on a variety of massively parallel archite [...]
+
+** License
+
+ASL is distributed under the free GNU Affero General Public License (AGPLv3) with an optional [[http://asl.org.il/licensing][commercial license]].
+
+** Support
+
+Professional consulting, training and integration services are provided by [[http://avtechscientific.com][Avtech Scientific]], whose team created and continues to extend the library. The company offers [[http://avtechscientific.com/services][innovative R&D solutions]] and is involved in diverse academic and industrial [[http://avtechscientific.com/projects][collaborative projects]] dealing with complex multidisciplinary problems.
+
+** Quick Start
+
+*** Installation
+
+1. Install [[http://cmake.org][cmake]] (>=3.0.2, BSD License) and the required libraries:
+   -  [[https://www.khronos.org/opencl][OpenCL]] (>=1.2, OpenCL Specification License); [[https://www.khronos.org/opencl/resources/opencl-open-source-opencl-implementations][open]] or [[https://www.khronos.org/opencl/resources/opencl-commercial-implementations][closed source]] implementation, see [[https://github.com/AvtechScientific/ASL/wiki/Deployment][deployment information]]
+   -  [[http://www.boost.org][boost]] (>=1.55, Boost Software License)
+   -  [[http://vtk.org][VTK]] (>=6.1, BSD License)
+   -  [[https://github.com/AvtechScientific/ASL/blob/master/cmake/ASLBuildOptions.cmake#L24][optional]]: Matlab support with [[https://sourceforge.net/projects/matio][matio]] (>=1.5.2, BSD License)
+   -  [[https://github.com/AvtechScientific/ASL/blob/master/cmake/ASLBuildOptions.cmake#L25][optional]]: API documentation with [[http://doxygen.org][doxygen]] (preferably with [[http://www.graphviz.org][graphviz]])
+
+2. Download and extract the [[https://github.com/AvtechScientific/ASL/releases/latest][ASL source code archive]].
+3. Create a build directory: =mkdir build-asl && cd build-asl=
+4. Use [[http://www.cmake.org/cmake/help/v3.2/manual/cmake-generators.7.html][cmake generator]] to produce Makefiles: =cmake -G "Unix Makefiles" ../ASL= or project files for your IDE (Visual Studio, Xcode, Eclipse, etc.): =cmake -G "Visual Studio 10" ../ASL=
+5. Run make (as root if installing into default destination =/usr/local=): =make install=
+
+*** Running an example
+
+1. Go to examples: =cd examples/flow/locomotive=
+2. Download geometry file [[http://asl.org.il/input_data/locomotive.stl][locomotive.stl]] from the [[http://asl.org.il/input_data][ASL input data page]].
+3. Run: =./asl-locomotive --input locomotive.stl=\\
+   Optionally: change parameters =./asl-locomotive --input locomotive.stl --dx 1 --dt 2= or write all of them into a file for later editing/reuse - =./asl-locomotive -g bigGrid.ini=. List all available options - =./asl-locomotive -h=.
+4. Post-processing: see [[https://github.com/AvtechScientific/ASL/wiki/User-Guide#post-processing][step by step example]] and [[http://asl.org.il/input_data/locomotive.pvsm][locomotive.pvsm]] - the ParaView state file.
+
+*** Writing your own code using ASL
+
+1. Take a look on [[http://asl.org.il/doc/Developer-Guide/examples.html][examples]] and the [[http://asl.org.il/doc/Developer-Guide/][API documentation]], start with [[http://asl.org.il/doc/Developer-Guide/locomotive_8cc-example.html][examples/flow/locomotive.cc]]
+2. ASL installation supplies =ASL.pc= and =ASLConfig.cmake= files. To build your program using:
+
+-  =pkg-config=: =c++ `pkg-config --cflags --libs ASL` -std=c++11 -o flow flow.cc=
+-  =cmake=: write a basic =CMakeLists.txt= file:
+
+#+BEGIN_SRC cmake
+    project(locomotive)
+    cmake_minimum_required(VERSION 3.0.2 FATAL_ERROR)
+    find_package(ASL 0.1.6 CONFIG REQUIRED)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+    add_executable(locomotive locomotive.cc)
+    target_link_libraries(locomotive PRIVATE ASL::aslnum ASL::aslvtk ASL::asl)
+#+END_SRC

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/asl.git

