From 28388680567b885fe0a3a8c2364175b8879108fd Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Fri, 17 Jan 2020 07:45:56 +0100 Subject: Rename conventions.txt --- Conventions.txt | 1 - code_conventions.md | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) delete mode 100644 Conventions.txt create mode 100644 code_conventions.md diff --git a/Conventions.txt b/Conventions.txt deleted file mode 100644 index e4ae7925..00000000 --- a/Conventions.txt +++ /dev/null @@ -1 +0,0 @@ -Please refer to the Wiki: https://gforge.inria.fr/plugins/mediawiki/wiki/gudhi/index.php/Conventions \ No newline at end of file diff --git a/code_conventions.md b/code_conventions.md new file mode 100644 index 00000000..e4ae7925 --- /dev/null +++ b/code_conventions.md @@ -0,0 +1 @@ +Please refer to the Wiki: https://gforge.inria.fr/plugins/mediawiki/wiki/gudhi/index.php/Conventions \ No newline at end of file -- cgit v1.2.3 From 3c535f32b56ff5ef6656bac71f56749fa44fcf23 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Fri, 17 Jan 2020 07:48:47 +0100 Subject: Add code conventions in markdown format --- code_conventions.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/code_conventions.md b/code_conventions.md index e4ae7925..5882f78e 100644 --- a/code_conventions.md +++ b/code_conventions.md @@ -1 +1,26 @@ -Please refer to the Wiki: https://gforge.inria.fr/plugins/mediawiki/wiki/gudhi/index.php/Conventions \ No newline at end of file +# Naming conventions + +## C++ + +### In the code: +* The classes and functions of a package should be in a sub-namespace of the `Gudhi` namespace. The sub-namespace names are in lowercase and use underscore separators. E.g. `Gudhi::package_name::` +* Concepts are named with camel case starting with uppercase. E.g. `PersistentHomology` for the concept of Persitence homology. +* Classes start with an uppercase letter and use underscore separators. E.g. `Skeleton_blocker_contractor`. +* Member functions and free functions are in lowercase and use underscore separators. E.g. `int num_vertices()`. +* Constants and macros are in uppercase. +* Macros should begin with the prefix `GUDHI_`. + +### File names: +* All headers are named *.h and all sources are named *.cpp. +* If a single class or function is provided in a file, its name (with the same letter case) should be used for the file name. +* If a file does not contain a single class, its name should not begin with a capital letter. +* Test files should be called `test_[what_is_tested].cpp`. E.g. `test_sparsify_point_set.cpp` +* Example files should be called `example_[what_it_is].cpp`. E.g. `example_sparsify_point_set.cpp` + +### In CMakeLists.txt files: +* The name of the "project" should be in this form: `Package_[tests|examples|…]`. E.g. `project(Simplex_tree_examples)`. +* The name if each "target" (first parameter of add_executable) should be in this form: `Package_{name of the cpp file without extension}`. E.g `add_executable(Subsampling_test_sparsify_point_set test_sparsify_point_set.cpp)`. + +## Python + +In progress... \ No newline at end of file -- cgit v1.2.3 From 2583f7a332cf4d18102f23ab86ac32ba03c33075 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Fri, 17 Jan 2020 07:56:42 +0100 Subject: A base file for next release announcements --- next_release.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 next_release.md diff --git a/next_release.md b/next_release.md new file mode 100644 index 00000000..2bbb2aee --- /dev/null +++ b/next_release.md @@ -0,0 +1,35 @@ +We are pleased to announce the release 3.1.0 of the GUDHI library. + +As a major new feature, the GUDHI library now offers 2 new Python modules: Persistence representations and Wasserstein distance. + +We are now using GitHub to develop the GUDHI library, do not hesitate to [fork the GUDHI project on GitHub](https://github.com/GUDHI/gudhi-devel). From a user point of view, we recommend to download GUDHI user version (gudhi.3.1.0.rc1.tar.gz). + +Below is a list of changes made since Gudhi 3.0.0: + +- [Persistence representations](https://gudhi.inria.fr/python/3.1.0.rc1/representations.html) (new Python module) + - Vectorizations, distances and kernels that work on persistence diagrams, compatible with scikit-learn. This module was originally available at https://github.com/MathieuCarriere/sklearn-tda and named sklearn_tda. + +- [Wasserstein distance](https://gudhi.inria.fr/python/3.1.0.rc1/wasserstein_distance_user.html) (new Python module) + - The q-Wasserstein distance measures the similarity between two persistence diagrams. + +- [Alpha complex](https://gudhi.inria.fr/doc/3.1.0.rc1/group__alpha__complex.html) (new C++ interface) + - Thanks to [CGAL 5.0 Epeck_d](https://doc.cgal.org/latest/Kernel_d/structCGAL_1_1Epeck__d.html) kernel, an exact computation version of Alpha complex dD is available and the default one (even in Python). + +- [Persistence graphical tools](https://gudhi.inria.fr/python/3.1.0.rc1/persistence_graphical_tools_user.html) (new Python interface) + - Axes as a parameter allows the user to subplot graphics. + - Use matplotlib default palette (can be user defined). + +- Miscellaneous + - Python `read_off` function has been renamed `read_points_from_off_file` as it only read points from OFF files. + - See the list of [bug fixes](https://github.com/GUDHI/gudhi-devel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A3.1.0+). + + +All modules are distributed under the terms of the MIT license. + +We kindly ask users to cite the GUDHI library as appropriately as possible in their papers, and to mention the use of the GUDHI library on the web pages of their projects using GUDHI and provide us with links to these web pages. + +We provide [bibtex entries](https://gudhi.inria.fr/doc/latest/_citation.html) for the modules of the User and Reference Manual, as well as for publications directly related to the GUDHI library. + +Feel free to [contact us](https://gudhi.inria.fr/contact/) in case you have any questions or remarks. + +For further information about downloading and installing the library ([C++](https://gudhi.inria.fr/doc/3.1.0.rc1/installation.html) or [Python](https://gudhi.inria.fr/python/3.1.0.rc1/installation.html)), please visit the [GUDHI web site](https://gudhi.inria.fr/). \ No newline at end of file -- cgit v1.2.3 From 3c77e0fdf51f59c91e0b36a4f8ba32da85e27a5d Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Fri, 17 Jan 2020 08:04:26 +0100 Subject: release review. Add some precisions on MIT --- next_release.md | 1 + 1 file changed, 1 insertion(+) diff --git a/next_release.md b/next_release.md index 2bbb2aee..6d749886 100644 --- a/next_release.md +++ b/next_release.md @@ -25,6 +25,7 @@ Below is a list of changes made since Gudhi 3.0.0: All modules are distributed under the terms of the MIT license. +There are still GPL dependencies for many modules, and so for an end-user it doesn't necessarily change much. We invite you to check our [license dedicated web page](https://gudhi.inria.fr/licensing/) for further details about this change. We kindly ask users to cite the GUDHI library as appropriately as possible in their papers, and to mention the use of the GUDHI library on the web pages of their projects using GUDHI and provide us with links to these web pages. -- cgit v1.2.3 From f8a5efa165241b9e27f06431e4919322b359ddb2 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Fri, 17 Jan 2020 09:13:37 +0100 Subject: No need to copy code conventions in user version --- src/cmake/modules/GUDHI_user_version_target.cmake | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/cmake/modules/GUDHI_user_version_target.cmake b/src/cmake/modules/GUDHI_user_version_target.cmake index 4fa74330..0b361a0f 100644 --- a/src/cmake/modules/GUDHI_user_version_target.cmake +++ b/src/cmake/modules/GUDHI_user_version_target.cmake @@ -32,8 +32,6 @@ file(COPY "${CMAKE_SOURCE_DIR}/biblio/bibliography.bib" DESTINATION "${CMAKE_CUR add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_BINARY_DIR}/biblio ${GUDHI_USER_VERSION_DIR}/biblio) -add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E - copy ${CMAKE_SOURCE_DIR}/Conventions.txt ${GUDHI_USER_VERSION_DIR}/Conventions.txt) add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/README.md ${GUDHI_USER_VERSION_DIR}/README.md) add_custom_command(TARGET user_version PRE_BUILD COMMAND ${CMAKE_COMMAND} -E -- cgit v1.2.3 From cc126a733a994571f8fc8b6004a8c8c6c2c81718 Mon Sep 17 00:00:00 2001 From: Marc Glisse Date: Sat, 18 Jan 2020 23:28:52 +0100 Subject: The license is not new anymore --- next_release.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/next_release.md b/next_release.md index 6d749886..08b736b1 100644 --- a/next_release.md +++ b/next_release.md @@ -20,12 +20,12 @@ Below is a list of changes made since Gudhi 3.0.0: - Use matplotlib default palette (can be user defined). - Miscellaneous - - Python `read_off` function has been renamed `read_points_from_off_file` as it only read points from OFF files. + - Python `read_off` function has been renamed `read_points_from_off_file` as it only reads points from OFF files. - See the list of [bug fixes](https://github.com/GUDHI/gudhi-devel/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3A3.1.0+). All modules are distributed under the terms of the MIT license. -There are still GPL dependencies for many modules, and so for an end-user it doesn't necessarily change much. We invite you to check our [license dedicated web page](https://gudhi.inria.fr/licensing/) for further details about this change. +However, there are still GPL dependencies for many modules. We invite you to check our [license dedicated web page](https://gudhi.inria.fr/licensing/) for further details. We kindly ask users to cite the GUDHI library as appropriately as possible in their papers, and to mention the use of the GUDHI library on the web pages of their projects using GUDHI and provide us with links to these web pages. @@ -33,4 +33,4 @@ We provide [bibtex entries](https://gudhi.inria.fr/doc/latest/_citation.html) fo Feel free to [contact us](https://gudhi.inria.fr/contact/) in case you have any questions or remarks. -For further information about downloading and installing the library ([C++](https://gudhi.inria.fr/doc/3.1.0.rc1/installation.html) or [Python](https://gudhi.inria.fr/python/3.1.0.rc1/installation.html)), please visit the [GUDHI web site](https://gudhi.inria.fr/). \ No newline at end of file +For further information about downloading and installing the library ([C++](https://gudhi.inria.fr/doc/3.1.0.rc1/installation.html) or [Python](https://gudhi.inria.fr/python/3.1.0.rc1/installation.html)), please visit the [GUDHI web site](https://gudhi.inria.fr/). -- cgit v1.2.3 From 784f9b5fdac6ff8c50b31479c1ae26f3efb823b2 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Mon, 20 Jan 2020 13:38:30 +0100 Subject: Release GUDHI 3.1.0 --- CMakeGUDHIVersion.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeGUDHIVersion.txt b/CMakeGUDHIVersion.txt index 8300b75e..ed19ecfb 100644 --- a/CMakeGUDHIVersion.txt +++ b/CMakeGUDHIVersion.txt @@ -1,6 +1,6 @@ set (GUDHI_MAJOR_VERSION 3) set (GUDHI_MINOR_VERSION 1) -set (GUDHI_PATCH_VERSION 0.rc1) +set (GUDHI_PATCH_VERSION 0) set(GUDHI_VERSION ${GUDHI_MAJOR_VERSION}.${GUDHI_MINOR_VERSION}.${GUDHI_PATCH_VERSION}) message(STATUS "GUDHI version : ${GUDHI_VERSION}") -- cgit v1.2.3