[hamradio-commits] [gnss-sdr] 109/149: Adding README and .gitignore

Sat Feb 6 19:43:09 UTC 2016

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

carles_fernandez-guest pushed a commit to branch next
in repository gnss-sdr.

commit 8159c1ec22de683e044eb314acc2258b043d0736
Author: Carles Fernandez <carles.fernandez at gmail.com>
Date:   Fri Jan 22 02:02:23 2016 +0100

    Adding README and .gitignore
---
 .../volk_gnsssdr_module/volk_gnsssdr/.gitignore    |  8 +++
 .../volk_gnsssdr_module/volk_gnsssdr/README.md     | 41 ++++++++++++
 .../volk_gnsssdr_module/volk_gnsssdr/README.txt    | 72 ----------------------
 3 files changed, 49 insertions(+), 72 deletions(-)

diff --git a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/.gitignore b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/.gitignore
new file mode 100644
index 0000000..eb4a6ac
--- /dev/null
+++ b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/.gitignore
@@ -0,0 +1,8 @@
+*~
+*.pyc
+*.pyo
+html/
+build/
+.project
+.cproject
+/.DS_Store
diff --git a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md
new file mode 100644
index 0000000..c788018
--- /dev/null
+++ b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.md
@@ -0,0 +1,41 @@
+# Welcome to VOLK_GNSSSDR, the Vector-Optimized Library of Kernels for GNSS-SDR
+
+VOLK_GNSSSDR is a sub-project of GNSS-SDR. This library provides a set of extra kernels that can be used stand-alone or in combination with VOLK's. Please see http://libvolk.org for documentation, source code, and contact information about the original VOLK.
+
+The boilerplate of this code was initially generated with ```volk_modtool```, an application provided by VOLK that creates the skeleton than can then be filled with custom kernels. Some modifications were added to accomodate the specificities of Global Navigation Satellite Systems (GNSS) signal processing. Those changes are clearly indicated in the source code, and do not break compatibility.
+
+This library contains kernels of hand-written SIMD code for different mathematical operations, mainly with 8-bit and 16-bit real and complex data types, offering a platform/architecture agnostic version that will run in all machines, plus other versions for different SIMD instruction sets. Then, the application ```volk_gnsssdr_profile``` runs some iterations of all versions that your machine can execute and annotates which is the fastest, which will then be selected at runtime when execu [...]
+
+These kernels have some specific features (e.g. saturation arithmetics) that are aimed to GNSS signal processing, but could make them not suitable for its general use in other applications. Check out the *generic* (that is, plain C) implementation to see what each kernel is actually doing.
+
+## How to use VOLK_GNSSSDR:
+
+This library is automatically built and installed along with GNSS-SDR if it is not found by CMake on your system at configure time.
+
+However, you can install and use VOLK_GNSSSDR kernels as you use VOLK's, independently from GNSS-SDR.
+
+In order to build and install the library, go to the base folder of the source code and do:
+
+~~~~~~ 
+$ mkdir build
+$ cd build
+$ cmake ..
+$ make
+$ sudo make install
+~~~~~~ 
+
+That's it!
+
+Before its first use, please execute ```volk_gnsssdr_profile``` to let your system know which is the fastest available implementation. This only has to be done once:
+
+~~~~~~ 
+$ volk_gnsssdr_profile
+~~~~~~
+
+From now on, GNSS-SDR (and any other program of your own that makes use of VOLK_GNSSSDR) will benefit from the acceleration provided by SIMD instructions available in your processor.
+
+___
+
+VOLK_GNSSSDR was originally created by Andres Cecilia Luque in the framework of the [Summer Of Code In Space (SOCIS 2014)](http://sophia.estec.esa.int/socis2014/?q=about "SOCIS 2014 webpage") program organized by the European Space Agency, and evolved since then by other authors (see each file header for main authorship). This software is released under the GNU General Public License version 3, see the file COPYING.
+
+This project is managed by [Centre Tecnologic de Telecomunicacions de Catalunya](http://www.cttc.es "CTTC webpage").
diff --git a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.txt b/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.txt
deleted file mode 100644
index a86f8be..0000000
--- a/src/algorithms/libs/volk_gnsssdr_module/volk_gnsssdr/README.txt
+++ /dev/null
@@ -1,72 +0,0 @@
-# This is VOLK_GNSSSDR, the Vector Optimized Library of Kernels for GNSS-SDR
-#
-#
-# Copyright (C) 2010-2015 (see AUTHORS file for a list of contributors)
-#
-# This file is part of GNSS-SDR.
-#
-# GNSS-SDR 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.
-#  
-# GNSS-SDR 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 GNSS-SDR. If not, see <http://www.gnu.org/licenses/>.
-
-This is a set of extra kernels that can be used in combination with VOLK's.
-Please see http://libvolk.org for bug tracking, documentation, source code, and 
-contact information about VOLK.
-
-The boilerplate of this code was originally generated with volk_modtool, and then
-some modifications were added to accomodate the specificities of these kernels.
-This library contains kernels of hand-written SIMD code for different mathematical
-operations, mainly with 8-bit and 16-bit data types, offering a generic, 
-platform/architecture agnostic version that will run in all machines, plus versions 
-for different SIMD instruction sets. Then, the application volk_gnsssdr_profile runs
-all versions that your machine can execute and annotates which is the fastest, that 
-will then be selected at runtime when executing GNSS-SDR. In this way, we can  address
-at the same time portability (by creating executables that will run in nearly 
-all processor architectures) and efficiency (by providing custom implementations 
-specially designed to take advantage of the specific processor that is running the code).
-
-These kernels have some specific features (i.e. saturation arithmetics) that are
-aimed to Global Navigation Satellite Systems signal processing, but could make
-them not suitable for its general use in other applications.
-
-
-How to use VOLK_GNSSSDR:
-
-It is automatically built and installed along with GNSS-SDR if it is not found by 
-CMake on your system at configure time.
-
-However, you can install and use VOLK_GNSSSDR kernels as you use VOLK's, independently 
-from GNSS-SDR.
-
-Build with cmake:
-
-    $ mkdir build
-    $ cd build
-    $ cmake ..
-    $ make
-    $ make test
-    $ sudo make install
-
-That's it!
-
-Before its first use, please execute volk_gnsssdr_profile to let the system know which 
-is the fastest available implementation. This only has to be done once:
-
-    $ volk_gnsssdr_profile
-    
-From now on, GNSS-SDR (and any other program of your own that makes use of VOLK_GNSSSDR) 
-will benefit from the acceleration provided by SIMD instructions.
-
-
-VOLK_GNSSSDR was originally created by Andres Cecilia Luque in the framework of the 
-Summer Of Code In Space (SOCIS 2014) program organized by the European Space Agency.
-
\ No newline at end of file

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-hamradio/gnss-sdr.git

