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..359cf66 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 continuous and discrete optimization. +--- + # lonkit **Local Optima Networks for Continuous Optimization** diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 0000000..0649b29 --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,23 @@ +{% extends "base.html" %} {% block extrahead %} +{{ super() }} + +{% endblock %} 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..590e49a 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 condition 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. 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 diff --git a/pyproject.toml b/pyproject.toml index 1c55410..5a1b7ea 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,6 +4,36 @@ 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", + "local-optima-networks", + "basin-hopping", + "evolutionary-algorithms", + "continuous-optimization", + "discrete-optimization", + "metaheuristics", + "fitness-landscape-analysis", + "visualization", + "multi-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",