Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release on GitHub #49

Merged
merged 1 commit into from
Apr 6, 2023
Merged

Release on GitHub #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "EvoLP"
uuid = "71f1f4bb-392f-41f8-8452-d535d061e0f4"
authors = ["Xavier Sánchez Díaz <[email protected]>"]
version = "0.9.0"
version = "0.9.5"

[deps]
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Expand Down
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# EvoLP - an evolutionary computation playground

[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-blue.svg)](https://github.com/invenia/BlueStyle)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://github.com/ntnu-ai-lab/EvoLP/blob/main/docs/src/index.md)
[![Stable](https://img.shields.io/badge/docs-latest-blue.svg)](https://ntnu-ai-lab.github.io/EvoLP.jl/)
[![Julia version](https://img.shields.io/badge/Julia-1.8-blueviolet.svg?logo=julia)](https://julialang.org)
[![GitHub](https://img.shields.io/github/license/ntnu-ai-lab/EvoLP)](https://github.com/ntnu-ai-lab/EvoLP/blob/main/LICENSE)
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-blue.svg)](https://github.com/invenia/BlueStyle)

---

Expand All @@ -21,9 +22,6 @@ Additionally, you can extend EvoLP to create new operators.

## Installation

> **Warning**
> WIP: The package is in the process of being submitted to the Julia Registry. Expect things to change a bit :)

You can install EvoLP from the REPL using the built-in package manager:

```julia
Expand All @@ -40,7 +38,7 @@ pkg> add EvoLP

## Getting started

- Read the documentation in this link as soon as it is hosted :^)
- Read the [documentation](https://ntnu-ai-lab.github.io/EvoLP.jl/).
- Browse some of the [examples](https://github.com/ntnu-ai-lab/EvoLP/tree/main/examples/) to see how to use the built-in algorithms.
- For a more comprehensive tutorial, read [the 8-queen problem](/examples/ga_k_queens.ipynb) where we construct an algorithm from scratch.

Expand Down
9 changes: 5 additions & 4 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

Welcome to the documentation for EvoLP!

[![GitHub source](https://img.shields.io/badge/GitHub-source-green.svg?logo=github)](https://github.com/ntnu-ai-lab/EvoLP.jl)
[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-blue.svg)](https://github.com/invenia/BlueStyle)
[![Julia version](https://img.shields.io/badge/Julia-1.8-blueviolet.svg?logo=julia)](https://julialang.org)

## What is EvoLP?

[EvoLP](https://github.com/ntnu-ai-lab/EvoLP) is a _playground_ for [evolutionary computation](https://en.wikipedia.org/wiki/Evolutionary_computation) in [Julia](https://julialang.org). It provides a set of predefined _building blocks_ that can be coupled together to quickly generate evolutionary computation solvers and compute statistics for a variety of optimisation tasks, including discrete, continuous and combinatorial optimisation.
Expand All @@ -19,10 +23,7 @@ Additionally, you can extend EvoLP to create [new operators](man/extending.md).

## Getting started

!!! note
TODO: Submit it to the package repository and make it installable.

- Read the [quick start](man/quickstart.md) page.
- Read the [quick start](man/quickstart.md) page for information about installation and to get a quick overview.
- Browse some of the [examples](tuto/oneplusone_onemax.md) to see how to use the built-in algorithms.
- For a more comprehensive tutorial, read the [8-queen problem](tuto/8_queen.md) where we make an algorithm from scratch.

Expand Down