From bc93d43478fb43d1e0343ce49a3320f6dee28bdc Mon Sep 17 00:00:00 2001 From: Azzaare Date: Mon, 11 Mar 2024 15:13:54 +0900 Subject: [PATCH] Basic structure for the book-ish part --- docs/make.jl | 16 ++++++++++++++-- docs/src/cp/advanced.md | 7 +++++++ docs/src/cp/applications.md | 7 +++++++ docs/src/cp/contribution.md | 7 +++++++ docs/src/cp/cp101.md | 10 ++++++++++ docs/src/cp/ecosystem.md | 7 +++++++ docs/src/cp/getting_started.md | 11 +++++++++++ docs/src/cp/intro.md | 4 ++-- docs/src/cp/models.md | 7 +++++++ docs/src/cp/opt.md | 11 +++++++++-- docs/src/cp/tuto_xp.md | 7 +++++++ docs/src/index.md | 2 +- 12 files changed, 89 insertions(+), 7 deletions(-) create mode 100644 docs/src/cp/advanced.md create mode 100644 docs/src/cp/applications.md create mode 100644 docs/src/cp/contribution.md create mode 100644 docs/src/cp/cp101.md create mode 100644 docs/src/cp/ecosystem.md create mode 100644 docs/src/cp/getting_started.md create mode 100644 docs/src/cp/models.md create mode 100644 docs/src/cp/tuto_xp.md diff --git a/docs/make.jl b/docs/make.jl index f148c9e..9448700 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -43,8 +43,20 @@ makedocs(; pages=[ "Home" => "index.md", "Constraint Programming" => [ - "Introduction" => "cp/intro.md", - "Optimization(s)?" => "cp/opt.md", + "Part 1: Basics" => [ + "Introduction" => "cp/intro.md", + "CP 101" => "cp/cp101.md", + "Optimization(s)?" => "cp/opt.md", + "Getting Started" => "cp/getting_started.md", + "Ecosystem" => "cp/ecosystem.md", + ], + "Part 2: Advanced" => [ + "CP Techniques" => "cp/advanced.md", + "Applications" => "cp/applications.md", + "Models" => "cp/models.md", + "Tutorials&XP" => "cp/tuto_xp.md", + "Contributing" => "cp/contribution.md", + ], ], "Constraints" => [ "ConstraintCommons.jl" => "constraints/constraint_commons.md", diff --git a/docs/src/cp/advanced.md b/docs/src/cp/advanced.md new file mode 100644 index 0000000..99bfe1a --- /dev/null +++ b/docs/src/cp/advanced.md @@ -0,0 +1,7 @@ +# Advanced Constraint Programming Techniques + +## Global Constraints and Their Uses +- Dive deeper into global constraints and how they simplify complex problems. + +## Search Strategies and Optimization +- Discuss various search strategies and their impact on solving CP problems. diff --git a/docs/src/cp/applications.md b/docs/src/cp/applications.md new file mode 100644 index 0000000..69d0be2 --- /dev/null +++ b/docs/src/cp/applications.md @@ -0,0 +1,7 @@ +# Applying Optimization Methods + +## Case Studies and Real-World Applications +- Showcase studies where CP and optimization have been successfully applied. + +## From Theory to Practice +- Guide readers through the process of formulating and solving an optimization problem from a real-world scenario. diff --git a/docs/src/cp/contribution.md b/docs/src/cp/contribution.md new file mode 100644 index 0000000..6e58f5a --- /dev/null +++ b/docs/src/cp/contribution.md @@ -0,0 +1,7 @@ +# Community and Contribution + +## Joining the JuliaConstraint Community +- Encourage readers to join the community, highlighting how they can contribute and collaborate. + +## Future Directions +- Share the vision for JuliaConstraint and upcoming projects or areas of research. \ No newline at end of file diff --git a/docs/src/cp/cp101.md b/docs/src/cp/cp101.md new file mode 100644 index 0000000..0779b08 --- /dev/null +++ b/docs/src/cp/cp101.md @@ -0,0 +1,10 @@ +# Constraint Programming 101 + +## What is Constraint Programming? +- Define CP and its significance in solving combinatorial problems. + +## Basic Concepts and Terminology +- Introduce key concepts such as constraints, domains, and variables. + +## How CP differs from other optimization techniques +- Contrast with other methods like linear programming and metaheuristics. diff --git a/docs/src/cp/ecosystem.md b/docs/src/cp/ecosystem.md new file mode 100644 index 0000000..b72c185 --- /dev/null +++ b/docs/src/cp/ecosystem.md @@ -0,0 +1,7 @@ +# Exploring JuliaConstraint Packages + +## Package Overviews +- Introduce each package within the JuliaConstraint organization, its purpose, and primary features. + +# Installation and Getting Started Guides +- Provide step-by-step instructions for installing and getting started with each package. diff --git a/docs/src/cp/getting_started.md b/docs/src/cp/getting_started.md new file mode 100644 index 0000000..d5a1cd6 --- /dev/null +++ b/docs/src/cp/getting_started.md @@ -0,0 +1,11 @@ +# Getting Started with Julia for CP and Optimization + +## Why Julia? + +- Discuss the advantages of Julia for computational science and optimization, highlighting its performance and ease of use. + +## Setting Up Your Julia Environment +- Guide on setting up Julia and essential packages for CP and optimization. + +## Your First Julia CP Model +- A simple tutorial to build and solve a basic CP model using Julia. diff --git a/docs/src/cp/intro.md b/docs/src/cp/intro.md index 1092253..3b1d751 100644 --- a/docs/src/cp/intro.md +++ b/docs/src/cp/intro.md @@ -1,4 +1,4 @@ -# Getting Started +# Welcome to Julia Constraints -A soon to be starting guide to Constraint Programming in Julia. +An introductory post/chapter that provides an overview of the JuliaConstraint organization, its mission, and what readers can expect to learn from the content. Highlight the importance of Constraint Programming (CP) and optimization in solving real-world problems. diff --git a/docs/src/cp/models.md b/docs/src/cp/models.md new file mode 100644 index 0000000..17a9e59 --- /dev/null +++ b/docs/src/cp/models.md @@ -0,0 +1,7 @@ +# Building and Analyzing Models + +## Modeling Best Practices +- Share best practices and tips for building efficient CP and optimization models. + +## Performance Analysis and Improvement +- Teach how to analyze and improve the performance of models. diff --git a/docs/src/cp/opt.md b/docs/src/cp/opt.md index 0292f94..6a4c098 100644 --- a/docs/src/cp/opt.md +++ b/docs/src/cp/opt.md @@ -1,4 +1,11 @@ -# The World of Optimization +# Dive into Optimization -Comparison and guidelines about the different way to do optimization. +## Understanding Optimization +- Explanation of optimization, types of optimization problems (e.g., linear, nonlinear, integer programming). + +## Metaheuristics Overview +- Introduce concepts like Genetic Algorithms, Simulated Annealing, and Tabu Search. + +## Mathematical Programming Basics +- Cover the fundamentals of mathematical programming and its role in optimization. diff --git a/docs/src/cp/tuto_xp.md b/docs/src/cp/tuto_xp.md new file mode 100644 index 0000000..de9641f --- /dev/null +++ b/docs/src/cp/tuto_xp.md @@ -0,0 +1,7 @@ +# Tutorials and Experiments + +## Hands-On Tutorials +- Provide step-by-step tutorials covering various topics and complexity levels. + +## Experimental Analysis +- Discuss the importance of experimental analysis in CP and how to conduct meaningful experiments. diff --git a/docs/src/index.md b/docs/src/index.md index 2068021..332f885 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -13,7 +13,7 @@ hero: actions: - theme: brand text: Constraint Programming ?! - link: /constraint_programming + link: /cp/intro - theme: alt text: View on Github link: https://github.com/JuliaConstraints/JuliaConstraints.github.io