From 1e905db7660d03583d8defb65a0e425428dfb1da Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 22:12:28 +0100 Subject: [PATCH 01/11] feat: update keywords and classifiers in pyproject.toml --- pyproject.toml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 1c55410..2de606d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,6 +4,33 @@ version = "0.1.0" description = "Local Optima Networks (LONs) for continuous optimization - Python implementation" readme = "README.md" requires-python = ">=3.10" +keywords = [ + "optimization", + "fitness-landscape", + "local-optima-networks", + "basin-hopping", + "evolutionary-algorithms", + "continuous-optimization", + "discrete-optimization", + "metaheuristics", + "fitness-landscape-analysis", + "visualization", + "mutli-dimensional" +] +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Science/Research", + "Intended Audience :: Developers", + "Topic :: Scientific/Engineering :: Artificial Intelligence", + "Topic :: Scientific/Engineering :: Mathematics", + "Topic :: Scientific/Engineering :: Visualization", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] dependencies = [ "numpy>=1.24.0", "scipy>=1.10.0", From 704042faa8f60e9c7128720e370a22c23834554c Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 22:18:12 +0100 Subject: [PATCH 02/11] feat: add frontmatter with descriptions for the docs pages --- docs/api/index.md | 4 ++++ docs/getting-started/concepts.md | 4 ++++ docs/getting-started/installation.md | 4 ++++ docs/getting-started/quickstart.md | 4 ++++ docs/index.md | 4 ++++ docs/user-guide/analysis.md | 4 ++++ docs/user-guide/examples.md | 4 ++++ docs/user-guide/sampling.md | 4 ++++ docs/user-guide/visualization.md | 4 ++++ 9 files changed, 36 insertions(+) diff --git a/docs/api/index.md b/docs/api/index.md index 259b49e..3ebbce9 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -1,3 +1,7 @@ +--- +description: Complete API reference for lonkit. Documentation for LON, CMLON, BasinHoppingSampler, LONVisualizer, and configuration classes. +--- + # API Reference Complete API documentation for lonkit. diff --git a/docs/getting-started/concepts.md b/docs/getting-started/concepts.md index fa93f9b..8c7e616 100644 --- a/docs/getting-started/concepts.md +++ b/docs/getting-started/concepts.md @@ -1,3 +1,7 @@ +--- +description: Description of Local Optima Networks, fitness landscapes, basin hopping, and CMLONs. Core concepts for optimization analysis. +--- + # Core Concepts This page explains the key concepts behind Local Optima Networks and how lonkit implements them. diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 8ba8208..359f43d 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -1,3 +1,7 @@ +--- +description: Installation of lonkit Python library via pip or from source. +--- + # Installation ## Requirements diff --git a/docs/getting-started/quickstart.md b/docs/getting-started/quickstart.md index f1891b4..52ff0fa 100644 --- a/docs/getting-started/quickstart.md +++ b/docs/getting-started/quickstart.md @@ -1,3 +1,7 @@ +--- +description: Getting started with lonkit. Basic API reference and guides on constructing, analyzing, and visualizing Local Optima Networks. +--- + # Quick Start This guide will get you up and running with lonkit in just a few minutes. diff --git a/docs/index.md b/docs/index.md index 028daaf..b01debd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ +--- +description: lonkit - Python library for constructing, analyzing, and visualizing Local Optima Networks (LONs) for and discrete optimization. +--- + # lonkit **Local Optima Networks for Continuous Optimization** diff --git a/docs/user-guide/analysis.md b/docs/user-guide/analysis.md index 46e33ab..ede9416 100644 --- a/docs/user-guide/analysis.md +++ b/docs/user-guide/analysis.md @@ -1,3 +1,7 @@ +--- +description: Analyzing Local Optima Networks using computed metrics. Funnel analysis, neutrality, strength metrics, and sink identification. +--- + # Analysis Guide This guide explains how to analyze LONs and interpret the computed metrics. diff --git a/docs/user-guide/examples.md b/docs/user-guide/examples.md index 0814226..74843f2 100644 --- a/docs/user-guide/examples.md +++ b/docs/user-guide/examples.md @@ -1,3 +1,7 @@ +--- +description: Complete examples demonstrating lonkit capabilities on benchmark optimization problems like Rastrigin, Ackley, and Sphere functions. +--- + # Examples Complete examples demonstrating lonkit's capabilities. diff --git a/docs/user-guide/sampling.md b/docs/user-guide/sampling.md index b17bca1..8437312 100644 --- a/docs/user-guide/sampling.md +++ b/docs/user-guide/sampling.md @@ -1,3 +1,7 @@ +--- +description: Configuration and usage of Basin-Hopping sampling for constructing Local Optima Networks. Perturbation, step size, and stopping conditions controls. +--- + # Sampling Guide This guide covers how to configure Basin-Hopping sampling for LON construction. diff --git a/docs/user-guide/visualization.md b/docs/user-guide/visualization.md index fc484bf..34f72e0 100644 --- a/docs/user-guide/visualization.md +++ b/docs/user-guide/visualization.md @@ -1,3 +1,7 @@ +--- +description: 2D and 3D visualizations of Local Optima Networks. Export plots as PNG, generate animated GIFs, and customize visual styling. +--- + # Visualization Guide This guide covers how to create visualizations of Local Optima Networks. From ca87e355452fea81cd23855ebff9cdc95f0ea705 Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 22:26:25 +0100 Subject: [PATCH 03/11] feat: add JSON-LD --- docs/overrides/main.html | 25 +++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 26 insertions(+) create mode 100644 docs/overrides/main.html diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..860d955 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,25 @@ +{% extends "base.html" %} + +{% block extrahead %} + +{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 7f6e5df..6704b5d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,7 @@ repo_url: https://github.com/helix-agh/lonkit theme: name: material + custom_dir: docs/overrides palette: - scheme: default primary: indigo From c8b426a14de9a446faebb0bcb5d47c7beb3c620d Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 22:48:04 +0100 Subject: [PATCH 04/11] feat: add project metadata including authors, license, and URLs --- pyproject.toml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 2de606d..4388184 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,6 +4,9 @@ version = "0.1.0" description = "Local Optima Networks (LONs) for continuous optimization - Python implementation" readme = "README.md" requires-python = ">=3.10" +authors = [{name = "HELIX AGH"}] +license = {text = "MIT"} +urls = {Homepage = "https://helix-agh.github.io/lonkit", Documentation = "https://helix-agh.github.io/lonkit", Repository = "https://github.com/helix-agh/lonkit", Issues = "https://github.com/helix-agh/lonkit/issues"} keywords = [ "optimization", "fitness-landscape", From b33e72df76d1e1afa7fdbde562b280d1e6b3521e Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 22:49:46 +0100 Subject: [PATCH 05/11] fix: typos --- docs/index.md | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.md b/docs/index.md index b01debd..359cf66 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ --- -description: lonkit - Python library for constructing, analyzing, and visualizing Local Optima Networks (LONs) for and discrete optimization. +description: lonkit - Python library for constructing, analyzing, and visualizing Local Optima Networks (LONs) for continuous and discrete optimization. --- # lonkit diff --git a/pyproject.toml b/pyproject.toml index 4388184..5a1b7ea 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -18,7 +18,7 @@ keywords = [ "metaheuristics", "fitness-landscape-analysis", "visualization", - "mutli-dimensional" + "multi-dimensional" ] classifiers = [ "Development Status :: 3 - Alpha", From e445d63eacbbb493ecf3957f25df65354e1a4725 Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 23:07:10 +0100 Subject: [PATCH 06/11] fix: remove hardocded software version --- docs/overrides/main.html | 41 +++++++++++++++++++--------------------- 1 file changed, 19 insertions(+), 22 deletions(-) diff --git a/docs/overrides/main.html b/docs/overrides/main.html index 860d955..e2b5c4f 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,25 +1,22 @@ -{% extends "base.html" %} - -{% block extrahead %} +{% extends "base.html" %} {% block extrahead %} {% endblock %} From bf7a2868e67910a8c0956f0068e96436a89b3039 Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 23:08:22 +0100 Subject: [PATCH 07/11] chore: fix typo --- docs/user-guide/sampling.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/sampling.md b/docs/user-guide/sampling.md index 8437312..590e49a 100644 --- a/docs/user-guide/sampling.md +++ b/docs/user-guide/sampling.md @@ -1,5 +1,5 @@ --- -description: Configuration and usage of Basin-Hopping sampling for constructing Local Optima Networks. Perturbation, step size, and stopping conditions controls. +description: Configuration and usage of Basin-Hopping sampling for constructing Local Optima Networks. Perturbation, step size, and stopping condition controls. --- # Sampling Guide From f054e436a886a0b608fea7a2e303a8d5841ab995 Mon Sep 17 00:00:00 2001 From: Massny Date: Tue, 17 Mar 2026 23:16:47 +0100 Subject: [PATCH 08/11] chore: add super() call in main.html override --- docs/overrides/main.html | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/overrides/main.html b/docs/overrides/main.html index e2b5c4f..0649b29 100644 --- a/docs/overrides/main.html +++ b/docs/overrides/main.html @@ -1,4 +1,5 @@ {% extends "base.html" %} {% block extrahead %} +{{ super() }}