diff --git a/CHANGELOG.md b/CHANGELOG.md index e50f90b..df24b11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [0.1.0] - 2024-07-08 +## [0.1.0] - 2024-07-05 ### Added - NSDlib version 0.1.0 release diff --git a/docs/conf.py b/docs/conf.py index 631efa1..46b717a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,3 +44,5 @@ html_theme = "sphinx_rtd_theme" html_static_path = ["_static"] + + diff --git a/docs/files/INTRODUCTION.md b/docs/files/INTRODUCTION.md index d3c3cb9..8eb80d8 100644 --- a/docs/files/INTRODUCTION.md +++ b/docs/files/INTRODUCTION.md @@ -9,5 +9,3 @@ of source detection methods, outbreak detection techniques, and propagation grap facilitating the development of new techniques to combat misinformation and improve propagation analysis. Each year, new techniques are introduced through scientific papers, often with only pseudo-code descriptions, making it difficult for researchers to evaluate and compare them with existing methods. NSDlib tries to bridge this gap and enhance researchers to put their implementations here. - -## diff --git a/docs/files/QUICK_START.md b/docs/files/QUICK_START.md index f7dd62d..4ddde30 100644 --- a/docs/files/QUICK_START.md +++ b/docs/files/QUICK_START.md @@ -38,7 +38,7 @@ print(evaluation) ``` -### direct method calls +### Direct method calls by importing and using specific method, each method has appropriate prefix to understand what is the purpose of it: ```python @@ -75,7 +75,8 @@ print(evaluation) This method allows you to directly specify the process of source detection, making it easy to do any modifications to standardlogic. ### Enum usage -- by using appropriate enum and method for computing desired method: +by using appropriate enum and method for computing desired method: + ```python import networkx as nx diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..78b3804 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,31 @@ +.. NSDLib documentation master file, created by + sphinx-quickstart on Tue Feb 20 15:27:13 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to NSDlib's documentation! +===================================== + +``NSDLib`` (Network source detection library) is a comprehensive library designed for detecting sources of propagation in networks. This library offers a variety of algorithms that help researchers and developers analyze and identify the origins of information (epidemic etc.) spread within networks. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + Introduction + Quick start + Contributing + Code of conduct + Reference + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + +.. _`Source`: https://github.com/damianfraszczak/nsdlib +.. _`Distribution`: https://pypi.org/project/nsdlib/ diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..4ec26b0 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +src +=== + +.. toctree:: + :maxdepth: 4 + + nsdlib diff --git a/docs/source/nsdlib.algorithms.algorithms_utils.rst b/docs/source/nsdlib.algorithms.algorithms_utils.rst new file mode 100644 index 0000000..a030dbe --- /dev/null +++ b/docs/source/nsdlib.algorithms.algorithms_utils.rst @@ -0,0 +1,7 @@ +nsdlib.algorithms.algorithms\_utils module +========================================== + +.. automodule:: nsdlib.algorithms.algorithms_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.evaluation.dynamic_age.rst b/docs/source/nsdlib.algorithms.evaluation.dynamic_age.rst new file mode 100644 index 0000000..64a1c9d --- /dev/null +++ b/docs/source/nsdlib.algorithms.evaluation.dynamic_age.rst @@ -0,0 +1,7 @@ +nsdlib.algorithms.evaluation.dynamic\_age module +================================================ + +.. automodule:: nsdlib.algorithms.evaluation.dynamic_age + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.evaluation.jordan_center.rst b/docs/source/nsdlib.algorithms.evaluation.jordan_center.rst new file mode 100644 index 0000000..0486d08 --- /dev/null +++ b/docs/source/nsdlib.algorithms.evaluation.jordan_center.rst @@ -0,0 +1,7 @@ +nsdlib.algorithms.evaluation.jordan\_center module +================================================== + +.. automodule:: nsdlib.algorithms.evaluation.jordan_center + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.evaluation.net_sleuth.rst b/docs/source/nsdlib.algorithms.evaluation.net_sleuth.rst new file mode 100644 index 0000000..f46233f --- /dev/null +++ b/docs/source/nsdlib.algorithms.evaluation.net_sleuth.rst @@ -0,0 +1,7 @@ +nsdlib.algorithms.evaluation.net\_sleuth module +=============================================== + +.. automodule:: nsdlib.algorithms.evaluation.net_sleuth + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.evaluation.rst b/docs/source/nsdlib.algorithms.evaluation.rst new file mode 100644 index 0000000..2eb341a --- /dev/null +++ b/docs/source/nsdlib.algorithms.evaluation.rst @@ -0,0 +1,20 @@ +nsdlib.algorithms.evaluation package +==================================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.algorithms.evaluation.dynamic_age + nsdlib.algorithms.evaluation.jordan_center + nsdlib.algorithms.evaluation.net_sleuth + +Module contents +--------------- + +.. automodule:: nsdlib.algorithms.evaluation + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.outbreaks.rst b/docs/source/nsdlib.algorithms.outbreaks.rst new file mode 100644 index 0000000..f9647ed --- /dev/null +++ b/docs/source/nsdlib.algorithms.outbreaks.rst @@ -0,0 +1,10 @@ +nsdlib.algorithms.outbreaks package +=================================== + +Module contents +--------------- + +.. automodule:: nsdlib.algorithms.outbreaks + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.reconstruction.rst b/docs/source/nsdlib.algorithms.reconstruction.rst new file mode 100644 index 0000000..26fb5ad --- /dev/null +++ b/docs/source/nsdlib.algorithms.reconstruction.rst @@ -0,0 +1,19 @@ +nsdlib.algorithms.reconstruction package +======================================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.algorithms.reconstruction.sbrp + nsdlib.algorithms.reconstruction.utils + +Module contents +--------------- + +.. automodule:: nsdlib.algorithms.reconstruction + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.reconstruction.sbrp.rst b/docs/source/nsdlib.algorithms.reconstruction.sbrp.rst new file mode 100644 index 0000000..1a8c9a8 --- /dev/null +++ b/docs/source/nsdlib.algorithms.reconstruction.sbrp.rst @@ -0,0 +1,7 @@ +nsdlib.algorithms.reconstruction.sbrp module +============================================ + +.. automodule:: nsdlib.algorithms.reconstruction.sbrp + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.reconstruction.utils.rst b/docs/source/nsdlib.algorithms.reconstruction.utils.rst new file mode 100644 index 0000000..a91acf4 --- /dev/null +++ b/docs/source/nsdlib.algorithms.reconstruction.utils.rst @@ -0,0 +1,7 @@ +nsdlib.algorithms.reconstruction.utils module +============================================= + +.. automodule:: nsdlib.algorithms.reconstruction.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.algorithms.rst b/docs/source/nsdlib.algorithms.rst new file mode 100644 index 0000000..d20af90 --- /dev/null +++ b/docs/source/nsdlib.algorithms.rst @@ -0,0 +1,28 @@ +nsdlib.algorithms package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.algorithms.evaluation + nsdlib.algorithms.outbreaks + nsdlib.algorithms.reconstruction + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.algorithms.algorithms_utils + +Module contents +--------------- + +.. automodule:: nsdlib.algorithms + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.common.exceptions.rst b/docs/source/nsdlib.common.exceptions.rst new file mode 100644 index 0000000..32affc5 --- /dev/null +++ b/docs/source/nsdlib.common.exceptions.rst @@ -0,0 +1,7 @@ +nsdlib.common.exceptions module +=============================== + +.. automodule:: nsdlib.common.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.common.models.rst b/docs/source/nsdlib.common.models.rst new file mode 100644 index 0000000..6f5f949 --- /dev/null +++ b/docs/source/nsdlib.common.models.rst @@ -0,0 +1,7 @@ +nsdlib.common.models module +=========================== + +.. automodule:: nsdlib.common.models + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.common.nx_utils.rst b/docs/source/nsdlib.common.nx_utils.rst new file mode 100644 index 0000000..ccfe9e9 --- /dev/null +++ b/docs/source/nsdlib.common.nx_utils.rst @@ -0,0 +1,7 @@ +nsdlib.common.nx\_utils module +============================== + +.. automodule:: nsdlib.common.nx_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.common.rst b/docs/source/nsdlib.common.rst new file mode 100644 index 0000000..795b5cc --- /dev/null +++ b/docs/source/nsdlib.common.rst @@ -0,0 +1,20 @@ +nsdlib.common package +===================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.common.exceptions + nsdlib.common.models + nsdlib.common.nx_utils + +Module contents +--------------- + +.. automodule:: nsdlib.common + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.commons.rst b/docs/source/nsdlib.commons.rst new file mode 100644 index 0000000..35f3ce2 --- /dev/null +++ b/docs/source/nsdlib.commons.rst @@ -0,0 +1,7 @@ +nsdlib.commons module +===================== + +.. automodule:: nsdlib.commons + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.rst b/docs/source/nsdlib.rst new file mode 100644 index 0000000..288b81f --- /dev/null +++ b/docs/source/nsdlib.rst @@ -0,0 +1,31 @@ +nsdlib package +============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.algorithms + nsdlib.common + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + nsdlib.commons + nsdlib.setup + nsdlib.source_detection + nsdlib.taxonomies + nsdlib.version + +Module contents +--------------- + +.. automodule:: nsdlib + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.setup.rst b/docs/source/nsdlib.setup.rst new file mode 100644 index 0000000..c25ec9a --- /dev/null +++ b/docs/source/nsdlib.setup.rst @@ -0,0 +1,7 @@ +nsdlib.setup module +=================== + +.. automodule:: nsdlib.setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.source_detection.rst b/docs/source/nsdlib.source_detection.rst new file mode 100644 index 0000000..4f4fe68 --- /dev/null +++ b/docs/source/nsdlib.source_detection.rst @@ -0,0 +1,7 @@ +nsdlib.source\_detection module +=============================== + +.. automodule:: nsdlib.source_detection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.taxonomies.rst b/docs/source/nsdlib.taxonomies.rst new file mode 100644 index 0000000..66b4060 --- /dev/null +++ b/docs/source/nsdlib.taxonomies.rst @@ -0,0 +1,7 @@ +nsdlib.taxonomies module +======================== + +.. automodule:: nsdlib.taxonomies + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/nsdlib.version.rst b/docs/source/nsdlib.version.rst new file mode 100644 index 0000000..8e99728 --- /dev/null +++ b/docs/source/nsdlib.version.rst @@ -0,0 +1,7 @@ +nsdlib.version module +===================== + +.. automodule:: nsdlib.version + :members: + :undoc-members: + :show-inheritance: