Difference between revisions of "Scilab---FOSSEE-Optimisation-Toolbox/C2/Installation-of-FOSSEE-Optimization-Toolbox/English"

From Script | Spoken-Tutorial
Jump to: navigation, search
Line 136: Line 136:
 
|-
 
|-
 
|Pop up window closes automatically >> '''Scilab console''' says "Finished"
 
|Pop up window closes automatically >> '''Scilab console''' says "Finished"
|After the popup closes automatically, check the '''Scilab console'''.
+
|After the popup window closes automatically, check the '''Scilab console'''.
  
 
If the update fails and you see any error messages, restart '''Scilab''' and repeat the steps.
 
If the update fails and you see any error messages, restart '''Scilab''' and repeat the steps.

Revision as of 22:01, 7 February 2022

Title of script: Installation of FOSSEE Optimization Toolbox

Author: Harpreet Singh, Georgey John, Rupak Rokade and Anandajith T S

Keywords:Scilab, FOSSEE Optimization Toolbox, Installation, FOT, Optimization Theory

Visual Cue Narration
Show Slide:

Title Slide

Hello and welcome to the Spoken Tutorial on “Installation of FOSSEE Optimization Toolbox in Scilab”.
Show Slide:

Learning Objectives

In this tutorial, we will learn how to:
  • Install the FOSSEE Optimization Toolbox.
  • Execute a few examples using the toolbox.
Show Slide:

System Requirements

To record this tutorial, I am using
  • Ubuntu 18.04 as the operating system and
  • Scilab 6.1.0
Show Slide:

Installation Requirements

For the installation-
  • We require a working Internet connection.
Show Slide:

Pre-requisite

Before practising this tutorial, a learner should have :
  • Basic knowledge of Scilab and Optimization Theory.

For Scilab, please refer to the Scilab tutorials available on the Spoken Tutorial website.

Show Slide:

What is FOSSEE Optimization Toolbox?

What is FOSSEE Optimization Toolbox?
  • FOT is a toolbox in Scilab.
  • It solves optimization problems using functions like linprog, fmincon and many others.
  • It can solve Linear Programming, Mixed-Integer Linear Programming, Quadratic Programming, Nonlinear Programming, minimax, goal-attain, least squares and Minimization/maximization with or without constraints problems.
There are several ways to install the toolbox.

I will demonstrate one of the ways.

Scilab console>> type atomsGui >> press Enter Open Scilab.

In the Scilab console, type atomsGui and press Enter.

Module Manager- ATOMS window

Point to Categories list on the left.

This will open the Module Manager- ATOMS window.

You will see a Categories list on the left side.

Click once on the Optimization category Click once on the Optimization category.
Point to the toolboxes This will show the toolboxes available in the Optimization category.
Click once on the FOSSEE Optimization Toolbox Click once on the FOSSEE Optimization Toolbox.
Point to the toolbox on the right

Scroll up

This will show the details of this toolbox on the right side of the window.

Scroll up until you see the Changelog statement.

Point to the version no. Make sure that the topmost version shown under Changelog, is the latest version.

At the time of recording, the latest version of FOT for me is version 0.4

Open a web browser >> type the url

https://atoms.scilab.org/

>> press Enter

Now how does one confirm which version of FOT is the latest?

To find out, open a web browser and type the url https://atoms.scilab.org/

And press Enter.

atoms web page. This will open the atoms web page.
In the search bar >> type fot >> press Enter

In the search bar type, fot and press Enter.

Point to FOSSEE Optimization Toolbox in the search result >> click on it You can see FOSSEE Optimization Toolbox in the search result. Click on it.
Highlight the version no. Notice that the version shown is 0.4 which is the latest version.
Switch to the Module Manager- ATOMS window. Now switch to the Module Manager- ATOMS window.
Click on the File menu >> click on Update List of Packages Do the following if you see an older version of FOT as the topmost version under Changelog.

On the top left corner of the window, click on File menu.

Then click on Update List of Packages.

Pop up window appears showing a progress bar. This will open a pop up window showing a progress bar.

It is updating the list of packages.

Pop up window closes automatically >> Scilab console says "Finished" After the popup window closes automatically, check the Scilab console.

If the update fails and you see any error messages, restart Scilab and repeat the steps.

For me, it says it has finished scanning the repository.

If the toolbox version shown in the Module Manager- ATOMS window is the latest one, we can install it.
Click on the Install button At the bottom of the window, click on the Install button.

If the installation is successful, Installation Done message appears at the bottom.

After this, it is required to restart Scilab.

Upon restart, the FOT toolbox will get loaded automatically.

Restart Scilab

FOT toolbox will get loaded automatically

I have restarted Scilab.

Notice that the FOT toolbox gets loaded on startup.

Let us now run a few examples to confirm if the installation was successful.
Type help in Scilab console >> press Enter.

Type help in the Scilab console and press Enter.

Help window opens >> on the left scroll to bottom of TOC This will open the Help window.

Scroll to the bottom of Table Of Contents on the left hand side.

Click on FOSSEE_Optimization_Toolbox Click on FOSSEE_Optimization_Toolbox
Point to help contents on this toolbox on the right This will open the Help contents on this toolbox on the right hand side.
Click on the fot_fmincon function. Click on the fot_fmincon function.

This function is used to solve a general nonlinear optimization problem.

Scroll down

Point to the first example. Click on the Execute button

Scroll down until you reach the Examples section.

Let us execute the first example.

Scroll to the right until you see the Execute button on the first example.

Click on the Execute button.

Switch to the Scilab console. Switch to the Scilab console.

You can see that the example got executed successfully.

Some of the values displayed on my console may differ from what you get.

You can safely ignore this.

Now let us execute one more example.

Switch to the Help window

Click on fot_linprog

Switch to the Help window.

On the left hand side, scroll down and click on fot_linprog

Scroll down

Click on the Execute button

On the right hand side, scroll down until you reach the Examples section.

Let us execute the first example.

Scroll to the right if needed, until you see the Execute button on the first example.

Click on the Execute button.

Switch to the Scilab console. Switch to the Scilab console.

You can see that the example got executed successfully.

Some of the values displayed on my console may differ from what you get.

You can safely ignore this.

Show Slide:

Summary

This brings us to the end of this tutorial.

Let us summarise.

In this tutorial, we have learnt to:

  • Install the FOSSEE Optimization Toolbox.
  • Execute examples from the Help menu in the toolbox.
Show Slide: About Spoken Tutorial project The video at the following link summarises the Spoken Tutorial project.

Please download and watch it

Show Slide: Spoken Tutorial Workshops The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.

Show Slide:

Answers for THIS Spoken Tutorial

Do you have questions in THIS Spoken Tutorial?

Please visit this site.

Choose the minute and second where you have the question

Explain your question briefly

The Spoken Tutorial project will ensure an answer

You will have to register to ask questions

Show Slide:

Forum for specific questions:

The Spoken Tutorial forum is for specific questions on this tutorial.

Please do not post unrelated and general questions on them.

This will help reduce the clutter.

With less clutter, we can use these discussions as instructional material.

Show Slide: FOSSEE Forum For any general or technical questions on Scilab, visit the FOSSEE forum and post your question.
Show Slide:

Textbook Companion project.

The FOSSEE team coordinates the Textbook Companion project.

We give Certificates and Honorarium to the contributors.

For more details, please visit this site.

Show Slide: Lab Migration The FOSSEE team coordinates the Lab Migration project.

For more details, please visit this site.

Show Slide: Acknowledgement Spoken Tutorial and FOSSEE projects are funded by MoE, Government of India.
Show Slide: Thank You The script has been created by FOSSEE Team, IIT Bombay.

And the video for this tutorial was created by Anandajith T S, FOSSEE intern 2021.

Thanks for joining.

Contributors and Content Editors

Anandajitht, Nancyvarkey, Priyanka.guntaka123