Skip to content

Commit

Permalink
Basic structure for the book-ish part
Browse files Browse the repository at this point in the history
  • Loading branch information
Azzaare committed Mar 11, 2024
1 parent 4a53b44 commit bc93d43
Show file tree
Hide file tree
Showing 12 changed files with 89 additions and 7 deletions.
16 changes: 14 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
7 changes: 7 additions & 0 deletions docs/src/cp/advanced.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions docs/src/cp/applications.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions docs/src/cp/contribution.md
Original file line number Diff line number Diff line change
@@ -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.
10 changes: 10 additions & 0 deletions docs/src/cp/cp101.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions docs/src/cp/ecosystem.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 11 additions & 0 deletions docs/src/cp/getting_started.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions docs/src/cp/intro.md
Original file line number Diff line number Diff line change
@@ -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.

7 changes: 7 additions & 0 deletions docs/src/cp/models.md
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 9 additions & 2 deletions docs/src/cp/opt.md
Original file line number Diff line number Diff line change
@@ -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.

7 changes: 7 additions & 0 deletions docs/src/cp/tuto_xp.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bc93d43

Please sign in to comment.