Merge pull request #117 from SU-HPC/hotfix/v0.2.2

Changed license to MIT and removed outdated docs
sparcityeu · May 31, 2022 · 501a719 · 501a719
2 parents ceb995e + 93a0288
commit 501a719
Show file tree

Hide file tree

Showing 21 changed files with 175 additions and 764 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,7 +6,7 @@ else()
   cmake_policy(VERSION 3.18)
 endif()
 
-project( SparseBase_project VERSION 0.2.1 )
+project( SparseBase_project VERSION 0.2.2 )
 option(RUN_TESTS "Enable running tests" OFF)
 option(_HEADER_ONLY "Use the library as a header only library?" OFF)
 option(CUDA "Enable CUDA" OFF)
@@ -110,3 +110,13 @@ install(
             "${CMAKE_CURRENT_BINARY_DIR}/sparsebaseConfigVersion.cmake"
     DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/sparsebase"
 )
+
+# install license
+install(
+    FILES LICENSE
+    DESTINATION include/sparsebase
+)
+install(
+    FILES LICENSE
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/sparsebase"
+)
diff --git a/LICENSE b/LICENSE
diff --git a/docs/index.rst b/docs/index.rst
@@ -37,4 +37,5 @@ If you are new to the project, we suggest starting here: :doc:`pages/getting_sta
    pages/how_to_guides/index
    api/library_root
    pages/contributing/index
+   pages/license
 
diff --git a/docs/pages/explanations/sparse_format.md b/docs/pages/explanations/sparse_format.md
diff --git a/docs/pages/getting_started.md b/docs/pages/getting_started.md
@@ -72,7 +72,7 @@ Where `${CUDA}` is `ON` if CUDA support is needed and `OFF` otherwise.
 This will prepare the library for installation and compile the example codes located in `build/examples`.
 
 
-## Installation
+### Installation
 
 To install the library, compile the library as shown in the previous section. Afterwards, you can install the library files either to the systems global location or to a custom location. To install the library to the default system location:
 ```bash

diff --git a/docs/pages/license.md b/docs/pages/license.md
@@ -0,0 +1,21 @@
+# License (MIT)
+
+**Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener**
+
+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.
diff --git a/src/sparsebase/context/context.h b/src/sparsebase/context/context.h
@@ -1,7 +1,11 @@
-//
-// Created by Amro on 3/31/2022.
-//
-
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_CONTEXT_CONTEXT_H_
 #define SPARSEBASE_SPARSEBASE_CONTEXT_CONTEXT_H_
 

diff --git a/src/sparsebase/context/cuda/context.cuh b/src/sparsebase/context/cuda/context.cuh
@@ -1,7 +1,11 @@
-//
-// Created by Amro on 3/31/2022.
-//
-
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_CONTEXT_CUDA_CONTEXT_H_
 #define SPARSEBASE_SPARSEBASE_CONTEXT_CUDA_CONTEXT_H_
 

diff --git a/src/sparsebase/feature/feature.h b/src/sparsebase/feature/feature.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_FEATURE_FEATURE_H_
 #define SPARSEBASE_SPARSEBASE_FEATURE_FEATURE_H_
 

diff --git a/src/sparsebase/format/cuda/format.cuh b/src/sparsebase/format/cuda/format.cuh
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #include "sparsebase/context/context.h"
 #include "sparsebase/context/cuda/context.cuh"
 #include "sparsebase/format/format.h"

diff --git a/src/sparsebase/format/format.h b/src/sparsebase/format/format.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_FORMAT_FORMAT_H_
 #define SPARSEBASE_SPARSEBASE_FORMAT_FORMAT_H_
 

diff --git a/src/sparsebase/object/object.h b/src/sparsebase/object/object.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_OBJECT_OBJECT_H_
 #define SPARSEBASE_SPARSEBASE_OBJECT_OBJECT_H_
 

diff --git a/src/sparsebase/preprocess/cuda/preprocess.cuh b/src/sparsebase/preprocess/cuda/preprocess.cuh
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_PREPROCESS_CUDA_PREPROCESS_H_
 #define SPARSEBASE_SPARSEBASE_PREPROCESS_CUDA_PREPROCESS_H_
 #include "sparsebase/format/cuda/format.cuh"

diff --git a/src/sparsebase/preprocess/preprocess.h b/src/sparsebase/preprocess/preprocess.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_PREPROCESS_PREPROCESS_H_
 #define SPARSEBASE_SPARSEBASE_PREPROCESS_PREPROCESS_H_
 #include "sparsebase/config.h"

diff --git a/src/sparsebase/sparsebase.h b/src/sparsebase/sparsebase.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_H_
 #define SPARSEBASE_SPARSEBASE_H_
 #include "sparsebase/config.h"

diff --git a/src/sparsebase/utils/converter/converter.h b/src/sparsebase/utils/converter/converter.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_UTILS_CONVERTER_CONVERTER_H_
 #define SPARSEBASE_SPARSEBASE_UTILS_CONVERTER_CONVERTER_H_
 

diff --git a/src/sparsebase/utils/converter/cuda/converter.cuh b/src/sparsebase/utils/converter/cuda/converter.cuh
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #include "sparsebase/format/cuda/format.cuh"
 #include "sparsebase/format/format.h"
 #include "sparsebase/utils/converter/converter.h"

diff --git a/src/sparsebase/utils/exception.h b/src/sparsebase/utils/exception.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_UTILS_EXCEPTION_H_
 #define SPARSEBASE_SPARSEBASE_UTILS_EXCEPTION_H_
 

diff --git a/src/sparsebase/utils/io/reader.h b/src/sparsebase/utils/io/reader.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_UTILS_IO_READER_H_
 #define SPARSEBASE_SPARSEBASE_UTILS_IO_READER_H_
 

diff --git a/src/sparsebase/utils/io/sparse_file_format.h b/src/sparsebase/utils/io/sparse_file_format.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_UTILS_IO_SPARSE_FILE_FORMAT_H_
 #define SPARSEBASE_SPARSEBASE_UTILS_IO_SPARSE_FILE_FORMAT_H_
 

diff --git a/src/sparsebase/utils/io/writer.h b/src/sparsebase/utils/io/writer.h
@@ -1,3 +1,11 @@
+/*******************************************************
+ * Copyright (c) 2022 SparCity, Amro Alabsi Aljundi, Taha Atahan Akyildiz, Arda Sener
+ * All rights reserved.
+ *
+ * This file is distributed under MIT license.
+ * The complete license agreement can be obtained at:
+ * https://github.com/SU-HPC/sparsebase/blob/main/LICENSE
+ ********************************************************/
 #ifndef SPARSEBASE_SPARSEBASE_UTILS_IO_WRITER_H_
 #define SPARSEBASE_SPARSEBASE_UTILS_IO_WRITER_H_