add first example

.github/workflows/ci.yml

@@ -0,0 +1,68 @@
+name: CI
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+    tags: '*'
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.6' # Replace this with the minimum Julia version that your package supports. E.g. if your package requires Julia 1.5 or higher, change this to '1.5'.
+          - '1' # Leave this line unchanged. '1' will automatically expand to the latest stable 1.x release of Julia.
+          - 'nightly'
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v1
+        with:
+          file: lcov.info
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - run: |
+          julia --project=docs -e '
+            using Pkg
+            Pkg.develop(PackageSpec(path=pwd()))
+            Pkg.instantiate()'
+      - run: |
+          julia --project=docs -e '
+            using Documenter: doctest
+            using Fridge
+            doctest(Fridge)' # change MYPACKAGE to the name of your package
+      - run: julia --project=docs docs/make.jl
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.gitignore

@@ -26,3 +26,6 @@ docs/site/
 # committed for packages, but should be committed for applications that require a static
 # environment.
 Manifest.toml
+
+# Large Data Files
+data/*

Project.toml

@@ -1,9 +1,16 @@
-name = "STMOZOO"
-uuid = "8e7dc78f-7190-4116-bf88-3d148ae9f088"
-authors = ["michielstock <michielfmstock@gmail.com>"]
+name = "Fridge"
+uuid = "673b17d6-c7db-4caa-9a54-38a02eba0033"
+authors = ["warvbell <wardvanbelle@gmail.com>"]
 version = "0.1.0"
 
 [deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+Cascadia = "54eefc05-d75b-58de-a785-1a3403f0919f"
+Coverage = "a2441757-f6aa-5fb2-8edb-039e3f45d037"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
+Gumbo = "708ec375-b3d6-5a57-a7ce-8257bf98657a"
+HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
+JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

@@ -1,14 +1,30 @@
-# STMO-ZOO
 
-Welcome to the STMO zoo! This is your final assignment for the course Selected Topics in Mathematical Optimization. Your goal is to implement an optimization method in Julia and contribute this to this repository. To pass, you have to:
+# Fridge.jl
+[![](https://img.shields.io/badge/docs-dev-blue)](https://wardvanbelle.github.io/Fridge.jl/dev) [![codecov](https://codecov.io/gh/wardvanbelle/Fridge.jl/branch/master/graph/badge.svg?token=GJ8JXBG5M1)](https://codecov.io/gh/wardvanbelle/Fridge.jl)\
+\
+<img align="right" width="150" height="150" src="FridgeLogo.png">
+by <i>Ward Van Belle</i>
 
-- fork this repo and create a pull request;
-- add a module to `src` with **at least one function**
-- add at least one unit test to the folder `test`;
-- document all your functions and add a page to the documentation page;
-- make a notebook in [Pluto](https://github.com/fonsp/Pluto.jl) and add it to `notebooks`;
-- perform a small code review of two other students.
+A package that optimizes your fridge use while reducing your waste pile!!
+
+This package tries to find the best recipes for you based on a recipe database. In our eyes (and the eyes of the objective function), the best recipes are the ones that use as much ingredients from your fridge as possible and that don't need extra ingredients from the grocery store.
+
+## How to use this package?
+There are several ways for you to use this package. 
+
+1. First and foremost you should have a **recipe database**. This database should be a .csv file or a .jld2 file containing the recipe names in one column and a list containing the ingredient names in the next column. For instance:
+
+    | recipeName | Ingredients |
+    |:----------:|:-----------:|
+    | french fries| potatoes, salt|
+    | boiled eggs | eggs, salt|
+
+2. If you just want to find an approximation of the best recipe combo. Then you can use the `greedyFindCombo` function. This performs a greedy search to find a quick solution. However, if you want a chance for a better solution, then you can use the `findBestRecipe` function. This function checks if your ingredients are in the database, and if not it offers possible alternatives. Next it uses **simulated annealing** to find a better recipe combination.
+
+## Help I don't have a database (recipeWebscraper.jl)
+
+Don't worry, we got you covered with `recipeWebscraper.jl`. This module includes a function that downloads recipes from [the cosylab recipe database](https://cosylab.iiitd.edu.in/recipedb/) based on their recipe number and exports them to a **.csv** file. 
+
+You can use the `scrapeRecipe` function for this. Using this method it is possible to download around 16 000 recipes before you get kicked from the site. Therefore it is recommended to look at the cuisine you would like to download and start from the earliest recipe number in this cuisine. Recipe numbers can be found by looking at the end of the url of a recipe page eg. [Belgian Chocolate Mousse](https://cosylab.iiitd.edu.in/recipedb/search_recipeInfo/106541) is the first Belgian recipe and has the recipe number **106541**.
 
-Depending on the project you choose some of these individual assignments might be really minimalistic, with other parts larger. For example, if you want to develop an application, say solving the graph coloring problem with Tabu Search, you might have only a single function in the source code (e.g., generating an instance) but have a fairly large notebook with a tutorial. On the other hand, if you work on a method, e.g., implementing Bee Colony Optimization, you might have many functions in the source code, while your notebook is only a demonstration on the test functions. 
 
-[![Build Status](https://travis-ci.org/MichielStock/STMOZOO.svg?branch=master)](https://travis-ci.org/MichielStock/STMOZOO)[![Coverage Status](https://coveralls.io/repos/github/MichielStock/STMOZOO/badge.svg?branch=master)](https://coveralls.io/github/MichielStock/STMOZOO?branch=master)

docs/Project.toml

@@ -1,3 +1,2 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-STMOZOO = "8e7dc78f-7190-4116-bf88-3d148ae9f088"

docs/make.jl

@@ -1,17 +1,17 @@
 using Documenter
 
-using STMOZOO
-using STMOZOO.Example
+using Fridge
 
-makedocs(sitename="STMO ZOO",
+makedocs(sitename="Fridge.jl",
     format = Documenter.HTML(),
-    modules=[Example], # add your module
-    pages=Any[
-        "Example"=> "man/example.md",  # add the page to your documentation
+    modules=[Fridge], # add your module
+    pages=[
+        "index.md",
+        "main function" => "mainFunction.md",
+        "search algorithms" => "searchAlgorithms.md",
+        "recipe webscraper"=> "recipeWebscraper.md",
     ])
 
-#=
 deploydocs(
-            repo = "github.com/michielstock/STMOZOO.jl.git",
-        )
-=#
+            repo = "github.com/wardvanbelle/Fridge.jl",
+        )

docs/src/index.md

@@ -1,7 +1,7 @@
-# STMO ZOO documentation
+# Fridge
+by *Ward Van Belle*
 
-This is the documentation page for the STMO ZOO packages (edition 2020-2021). This is the place for the **documentation**
-of your function. So explain the main functionality of your module and list the documentation of your funtions.
+This package tries to find the best recipes for you based on a recipe database. In our eyes (and the eyes of the objective function), the best recipes are the ones that use as much ingredients from your fridge as possible and that don't need extra ingredients from the grocery store.
 
 ```@contents
 ```

docs/src/mainFunction.md

@@ -0,0 +1,11 @@
+## Overview Function
+
+```@docs
+findBestRecipe
+```
+
+This function checks the ingredients by using the `checkIngredients` function:
+
+```@docs
+checkIngredients
+```

docs/src/recipeWebscraper.md

@@ -0,0 +1,14 @@
+```@docs
+
+```
+
+
+# recipeWebscraper
+
+This is a supporting module that allows the user to download recipes from [the cosylab recipe database](https://cosylab.iiitd.edu.in/recipedb/) based on their recipe number and exports them to a **.csv** file.
+
+## scrapeRecipe
+
+```@docs
+scrapeRecipe
+```

docs/src/searchAlgorithms.md

@@ -0,0 +1,22 @@
+## Search Algorithms
+
+This page includes some more information on the two search methods used.
+
+### Greedy Search
+
+```@docs
+greedyFindCombo
+```
+
+### Simulated Annealing
+
+```@docs
+SAFindCombo
+```
+
+### Neighbour Functions
+
+```@docs
+randomCombo
+Neighbour
+```