Script | Spoken-Tutorial - User contributions [en]

Osdag/C3/Design-report-in-Osdag/English

2023-10-30T19:08:46Z

Anandajitht:

'''Title of the script: Design report in Osdag'''

'''Author''': Anandajith TS

'''Keywords:''' '''Osdag, member design, connection design, steel design optimisation, Tension member, design report, design check, proof-checking, IS 800, video tutorial.'''

{|border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide'''

'''Title Slide'''
|| Welcome to the spoken tutorial on '''‘Design report in Osdag’'''
|-
|| '''Slide '''

'''Learning Objectives'''
|| In this tutorial, we will learn how to,
* Save '''design report '''in Osdag
* Create a user '''profile'''
* Interpret the '''design report'''
* Read the '''IS code''' checks in the '''design report'''

|-
|| '''Slide '''

'''System Requirements'''
|| To record this tutorial, I am using,
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide'''

'''Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial, you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.
|-
|| '''Slide'''

'''Code Files'''
||
* The files used in this tutorial are available in the '''Code Files''' link
* Please download and extract them
* Make a copy and then use them while practising

|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Let us switch to the '''home page''' of '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Click on '''File, '''Select''' Load Input.'''

Select the '''Input file '''and click '''Open '''to load the file.
|| Load the '''Report hyphen sample hyphen design dot OSI '''file and perform the design.
|-
|| Click on Design button.
|| Click on the''' Design''' button to show the '''CAD''' model and outputs.
|-
|| Point towards the '''CAD window '''and the '''Output Dock'''
|| We see the '''CAD model''' and '''outputs''' as the design is successful'''.'''
|-
|| Highlight ‘Overall bolted tension member design is safe.’ in the '''Log messages '''window
|| The '''Log message '''indicates that the design is safe.
|-
|| Only narration
|| Let us now save the '''design report''' for our design.
|-
|| Only narration
|| Please note, '''Osdag '''performs a design multiple times iteratively based on the given inputs.
|-
|| Only narration
|| However, only the latest checks are echoed in the '''design report'''.
|-
|| Only narration
|| We can create a '''design report '''in two ways.
|-
|| Point towards the '''Create Design Report''' button
|| By clicking '''Create Design Report '''button at the bottom of the output dock.

Or
|-
|| Click on the file menu and point towards the '''Create design report''' option.
|| By navigating to '''File '''menu and selecting '''Create design report'''.
|-
|| Point towards the '''Create Design Report''' button
|| Click the '''Create Design Report '''button at the bottom of the output dock.
|-
|| Point towards the '''Design Report Summary''' window
|| The '''Design Report Summary''' window opens.
|-
|| Point towards the '''Design Report Summary''' window.
|| The summary window collects basic details pertaining to the report and design.
|-
|| Point towards the '''OK '''button
|| This step is optional, users can skip it by simply clicking the '''OK '''button.
|-
|| Only narration
|| However, it is a good practice to provide a summary to the report.
|-
|| Point to the summary details.
|| Let us go ahead and fill in the summary details'''.'''
|-
|| Type '''IIT BOMBAY '''in the '''Company Name''' field
|| I will type the company's name''' '''as '''IIT Bombay'''.
|-
|| Only narration
|| You may type any other name of your choice.
|-
|| Click on the '''Browse '''button
|| To attach a company logo to the report, click on the '''Browse '''button.
|-
|| Only narration
|| The '''Open Image''' window opens.
|-
|| Browse to the directories and select the '''IIT BOMBAY''' logo
|| I will browse to the location where my company logo is saved.
|-
|| Only narration
|| The image used should be a PNG, SVG or JPG and preferably smaller in size.
|-
|| Click on the '''IITB_logo'''
|| I will select the logo and click on the '''Open '''button below.
|-
|| Only narration
|| You may select any logo of your choice.
|-
|| Type '''Osdag '''in the '''Group/Team Name''' field
|| I will type the '''Group Name '''as '''Osdag.'''
|-
|| Type '''Anandajith TS '''in the '''Designer '''field
|| In the '''Designer '''field I will type my name.
|-
|| Point to the information.
|| Users can save the information as a profile to avoid typing it every time.
|-
|| Point toward the '''Save Profile '''button
|| This can be done by clicking the '''Save Profile''' button.
|-
|| Only narration
|| I will skip this step as I have already saved my profile.

Users may pause the tutorial and save their profile.
|-
|| Point toward the '''Use Profile '''button.

Click the '''User Profile''' button.
|| Let us load the saved profile.

Click the '''Use Profile''' button and select the desired profile.
|-
|| Point to all the details.
|| All the details and logo will be automatically loaded.
|-
|| Type '''Tension Member Design '''in the Project Title field
|| Next, let us specify the project title as '''Tension Member Design.'''
|-
|| Point towards the '''Subtitle''', '''Job Number''', '''Client '''and '''Additional Comments''' fields
|| I will skip '''Subtitle''', '''Job Number''', '''Client '''and '''Additional Comments''' fields.
|-
|| Click on the '''OK '''button
|| Click on the '''OK '''button below to proceed.
|-
|| Point to the Save File As window.
|| The '''Save File As '''window will open.
|-
|| Browse to the '''Osdag-workspace''' directory
|| I will browse to the '''Osdag hyphen workspace''' directory on my computer.
|-
|| Type '''tension-member-bolted '''in the '''File name''' field
|| Define a suitable filename.

I will type the file name as tension-member-bolted.
|-
|| Point toward the '''Files of type''' field
|| The default and the only file format in which we can save the report is '''PDF'''.
|-
|| Click on the '''Save '''button
|| Click on the '''Save '''button to save the design report.
|-
|| Only narration
|| It may take some time to save the design report.
|-
|| Click on the OK button
|| A message pops up once the report is saved.

Click the '''OK '''button''' '''to acknowledge it.
|-
|| Only narration
|| We have successfully saved the design report.
|-
|| Only narration
|| Next, we will review the report and interpret the checks.
|-
|| Open the '''tension-member-bolted.PDF '''file in the browser
|| I have opened the report in the Edge web browser.
|-
|| Only narration
|| You may open the report using any PDF viewer like '''Adobe '''or the browser of your choice.
|-
|| Point toward the header of the report
|| The summary details provided in the profile are printed in the header of the report.
|-
|| Point to the details.
|| This is helpful when we need to share the design reports with other stakeholders.
|-
|| Scroll and show the report.
|| The design report is divided into multiple sections and sub-sections.
|-
|| '''Page 1''':

Point toward '''1 Input Parameters'''
|| Section 1 echoes the '''Input Parameters'''.
|-
|| '''Page 1''':

Point towards the fields in the '''Input Parameters '''section
|| These are all the inputs we defined in the '''input dock '''during the design stage.
|-
|| '''Page 1''':

Point toward '''Detailing - Design Preference '''field
|| Inputs and assumptions from the '''Design Preference '''menu are also shown.
|-
|| '''Page 2''':

Point toward '''2 Design Checks'''
|| On page 2, we have the '''Design Checks'''.
|-
|| '''Page 2''':

Point toward''' Design Status'''
|| The overall status of the design is marked here.
|-
|| '''Page 2''':

Point toward''' Pass'''
|| The '''Design Status''' reads '''Pass.'''

It is marked in green as our design is safe and passes all the checks.
|-
|| '''Page 2''':
|| If any of the checks fail, the overall status is marked as '''Fail '''in red.
|-
|| '''Page 2''':

Point toward '''2.1 Selected Member Data'''
|| Section 2.1 shows the '''Selected Member Data'''
|-
|| '''Page 2''':

Point toward the '''Section Size*''' field in the''' Selected Member Data'''
|| '''LC 125 '''is the selected member for this design.

It is from the list of sections defined during the trial design.
|-
|| '''Page 2''':

Point toward '''2.2 Spacing Check'''
|| Let us go to section 2.2.

From here we see design checks that '''Osdag '''performed during the design stage.
|-
|| '''Page 2''':

Point to the tables.
|| These checks are displayed in a tabular format.
|-
|| '''Page 2''':

Point toward the '''Check '''column
|| The '''Check '''column displays the name of the check that is being performed.
|-
|| '''Page 2''':

Point toward the '''Required '''column
|| The '''Required '''column displays the minimum required value.

These values are calculated using relevant '''Indian Standard''' clauses and checks.
|-
|| '''Page 2''':

Point toward the '''Provided '''column
|| '''Provided '''column displays the provided values.
|-
|| '''Page 2''':

Point toward the '''Provided '''column
|| The provided values are higher than the required values.

These values are optimal and ensure the overall economy of the design.
|-
|| '''Page 2''':

Point toward the '''Remarks '''column
|| Finally, a colour-coded remark is made against the check.

Typically, it shows if that particular check has passed or failed.
|-
|| Keep scrolling through page 3 and page 4:

Only narration
|| Similarly, all the checks pertaining to the design are listed with details.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''Min. Pitch Distance (mm) '''in the '''Check '''column
|| Let us interpret a design check.

This check is for the minimum '''pitch '''distance.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''pmin '''in the '''Required '''column
|| The minimum '''pitch '''distance required is 2.5 times the '''bolt '''diameter or greater.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''[Ref. IS 800:2007, Cl.10.2.2] '''in the '''Required '''column
|| The reference clause for this check is mentioned below.

It is based on clause '''10.2.2''' of '''IS 800, 2007'''.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''35.0 '''in the '''Required '''column
|| Let us look at the minimum required '''pitch '''distance.

It is calculated as 35 mm for a bolt of 14 mm diameter.

|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''35 '''in the '''Provided '''column
|| The provided value is 35 mm, which is equal to the required value.

|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''Pass '''in the '''Remarks '''column
|| Thus, the check is marked as '''Pass '''as it satisfies the check condition.
|-
|| Keep scrolling through page 6 to page 11:

Only narration
|| We see that all the checks are carried out in the similar manner.
|-
|| Keep scrolling through page 6 to page 11:

Only narration
|| This makes interpreting the checks very easy.
|-
|| Keep scrolling through page 6 to page 11:

Only narration
|| Novice designers can use this report to learn about the design checks.

They can use it to design a process.
|-
|| '''Page 12''':

Point toward '''3 3D Views '''
|| The 3D and 2D views of the CAD model are also shown as a reference.
|-
|| '''Page 12''':

Only narration
|| We have already seen how to save 3D CAD models in the previous tutorial.
|-
|| '''Page 12''':

Point toward '''Design Logs'''
|| The design '''logs '''pertaining to a design session are also printed.
|-
|| '''Page 12''':

Point toward '''Design Logs'''
|| We can interpret log messages to understand how the design was carried out.

|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide '''

'''Summary'''

|| In this tutorial, we have
* Saved the '''design report '''in Osdag
* Created a user profile
* Interpreted the '''design report'''
* Read the '''IS code''' checks in the '''design report'''

|-
|| '''Slide '''

'''Assignment'''
|| As an '''assignment''', do the following
* Interpret all the checks of the saved design report
* Validate the checks against the values in the '''Output Dock'''

|-
|| '''Slide '''

'''About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide'''

'''Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide'''

'''Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum.
|-
|| '''Slide '''

'''FOSSEE Forum'''
|| For any general or technical questions on '''Osdag''', visit the '''FOSSEE forum''' and post your question.
|-
|| '''Slide '''

'''Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit the link below [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide '''

'''Acknowledgements'''
|| The '''Spoken Tutorial''' project was established by the '''Ministry of Education''', Government of India.
|-
|| '''Slide '''

'''Thank you'''
|| This is Anandajith TS, FOSSEE IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C3/Design-report-in-Osdag/English

2023-10-23T19:22:02Z

Anandajitht: Created page with " '''Title of the script: Design report in Osdag''' '''Author''': Anandajith TS '''Keywords:''' '''Osdag, member design, connection design, steel design optimisation, Tensio..."

'''Title of the script: Design report in Osdag'''

'''Author''': Anandajith TS

'''Keywords:''' '''Osdag, member design, connection design, steel design optimisation, Tension member, design report, design check, proof-checking, IS 800, video tutorial.'''

{|border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide'''

'''Title Slide'''
|| Welcome to the spoken tutorial on '''‘Design report in Osdag’'''
|-
|| '''Slide '''

'''Learning Objectives'''
|| In this tutorial, we will learn how to,
* Save '''design report '''in Osdag
* Create a user '''profile'''
* Interpret the '''design report'''
* Read the '''IS code''' checks in the '''design report'''

|-
|| '''Slide '''

'''System Requirements'''
|| To record this tutorial, I am using,
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide'''

'''Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial, you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.
|-
|| '''Slide'''

'''Code Files'''
||
* The files used in this tutorial are available in the '''Code Files''' link
* Please download and extract them
* Make a copy and then use them while practising

|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Let us switch to the '''home page''' of '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Click on '''File, '''Select''' Load Input.'''

Select the '''Input file '''and click '''Open '''to load the file.
|| Load the '''Report hyphen sample hyphen design dot OSI '''file and perform the design.
|-
|| Click on Design button.
|| Click on the''' Design''' button to show the '''CAD''' model and outputs.
|-
|| Point towards the '''CAD window '''and the '''Output Dock'''
|| We see the '''CAD model''' and '''outputs''' as the design is successful'''.'''
|-
|| Highlight ‘Overall bolted tension member design is safe.’ in the '''Log messages '''window
|| The '''Log message '''indicates that the design is safe.
|-
|| Only narration
|| Let us now save the '''design report''' for our design.
|-
|| Only narration
|| Please note, '''Osdag '''performs a design multiple times iteratively based on the given inputs.
|-
|| Only narration
|| However, only the latest checks are echoed in the '''design report'''.
|-
|| Only narration
|| We can create a '''design report '''in two ways.
|-
|| Point towards the '''Create Design Report''' button
|| By clicking '''Create Design Report '''button at the bottom of the output dock.

Or
|-
|| Click on the file menu and point towards the '''Create design report''' option.
|| By navigating to '''File '''menu and selecting '''Create design report'''.
|-
|| Point towards the '''Create Design Report''' button
|| Click the '''Create Design Report '''button at the bottom of the output dock.
|-
|| Point towards the '''Design Report Summary''' window
|| The '''Design Report Summary''' window opens.
|-
|| Point towards the '''Design Report Summary''' window.
|| The summary window collects basic details pertaining to the report and design.
|-
|| Point towards the '''OK '''button
|| This step is optional, users can skip it by simply clicking the '''OK '''button.
|-
|| Only narration
|| However, it is a good practice to provide a summary to the report.
|-
|| Point to the summary details.
|| Let us go ahead and fill in the summary details'''.'''
|-
|| Type '''IIT BOMBAY '''in the '''Company Name''' field
|| I will type the company's name''' '''as '''IIT Bombay'''.
|-
|| Only narration
|| You may type any other name of your choice.
|-
|| Click on the '''Browse '''button
|| To attach a company logo to the report, click on the '''Browse '''button.
|-
|| Only narration
|| The '''Open Image''' window opens.
|-
|| Browse to the directories and select the '''IIT BOMBAY''' logo
|| I will browse to the location where my company logo is saved.
|-
|| Only narration
|| The image used should be a PNG, SVG or JPG and preferably smaller in size.
|-
|| Click on the '''IITB_logo'''
|| I will select the logo and click on the '''Open '''button below.
|-
|| Only narration
|| You may select any logo of your choice.
|-
|| Type '''Osdag '''in the '''Group/Team Name''' field
|| I will type the '''Group Name '''as '''Osdag.'''
|-
|| Type '''Anandajith TS '''in the '''Designer '''field
|| In the '''Designer '''field I will type my name.
|-
|| Point to the information.
|| Users can save the information as a profile to avoid typing it every time.
|-
|| Point toward the '''Save Profile '''button
|| This can be done by clicking the '''Save Profile''' button.
|-
|| Only narration
|| I will skip this step as I have already saved my profile.

Users may pause the tutorial and save their profile.
|-
|| Point toward the '''Use Profile '''button.

Click the '''User Profile''' button.
|| Let us load the saved profile.

Click the '''Use Profile''' button and select the desired profile.
|-
|| Point to all the details.
|| All the details and logo will be automatically loaded.
|-
|| Type '''Tension Member Design '''in the Project Title field
|| Next, let us specify the project title as '''Tension Member Design.'''
|-
|| Point towards the '''Subtitle''', '''Job Number''', '''Client '''and '''Additional Comments''' fields
|| I will skip '''Subtitle''', '''Job Number''', '''Client '''and '''Additional Comments''' fields.
|-
|| Click on the '''OK '''button
|| Click on the '''OK '''button below to proceed.
|-
|| Point to the Save File As window.
|| The '''Save File As '''window will open.
|-
|| Browse to the '''Osdag-workspace''' directory
|| I will browse to the '''Osdag hyphen workspace''' directory on my computer.
|-
|| Type '''tension-member-bolted '''in the '''File name''' field
|| Define a suitable filename.

I will type the file name as tension-member-bolted.
|-
|| Point toward the '''Files of type''' field
|| The default and the only file format in which we can save the report is '''PDF'''.
|-
|| Click on the '''Save '''button
|| Click on the '''Save '''button to save the design report.
|-
|| Only narration
|| It may take some time to save the design report.
|-
|| Click on the OK button
|| A message pops up once the report is saved.

Click the '''OK '''button''' '''to acknowledge it.
|-
|| Only narration
|| We have successfully saved the design report.
|-
|| Only narration
|| Next, we will review the report and interpret the checks.
|-
|| Open the '''tension-member-bolted.PDF '''file in the browser
|| I have opened the report in the Edge web browser.
|-
|| Only narration
|| You may open the report using any PDF viewer like '''Adobe '''or the browser of your choice.
|-
|| Point toward the header of the report
|| The summary details provided in the profile are printed in the header of the report.
|-
|| Point to the details.
|| This is helpful when we need to share the design reports with other stakeholders.
|-
|| Scroll and show the report.
|| The design report is divided into multiple sections and sub-sections.
|-
|| '''Page 1''':

Point toward '''1 Input Parameters'''
|| Section 1 echoes the '''Input Parameters'''.
|-
|| '''Page 1''':

Point towards the fields in the '''Input Parameters '''section
|| These are all the inputs we defined in the '''input dock '''during the design stage.
|-
|| '''Page 1''':

Point toward '''Detailing - Design Preference '''field
|| Inputs and assumptions from the '''Design Preference '''menu are also shown.
|-
|| '''Page 2''':

Point toward '''2 Design Checks'''
|| On page 2, we have the '''Design Checks'''.
|-
|| '''Page 2''':

Point toward''' Design Status'''
|| The overall status of the design is marked here.
|-
|| '''Page 2''':

Point toward''' Pass'''
|| The '''Design Status''' reads '''Pass.'''

It is marked in green as our design is safe and passes all the checks.
|-
|| '''Page 2''':
|| If any of the checks fail, the overall status is marked as '''Fail '''in red.
|-
|| '''Page 2''':

Point toward '''2.1 Selected Member Data'''
|| Section 2.1 shows the '''Selected Member Data'''
|-
|| '''Page 2''':

Point toward the '''Section Size*''' field in the''' Selected Member Data'''
|| '''LC 125 '''is the selected member for this design.

It
is from the list of sections defined during the trial design.
|-
|| '''Page 2''':

Point toward '''2.2 Spacing Check'''
|| Let us go to section 2.2.

From here we see design checks that '''Osdag '''performed during the design stage.
|-
|| '''Page 2''':

Point to the tables.
|| These checks are displayed in a tabular format.
|-
|| '''Page 2''':

Point toward the '''Check '''column
|| The '''Check '''column displays the name of the check that is being performed.
|-
|| '''Page 2''':

Point toward the '''Required '''column
|| The '''Required '''column displays the minimum required value.

These values are calculated using relevant '''Indian Standard''' clauses and checks.
|-
|| '''Page 2''':

Point toward the '''Provided '''column
|| '''Provided '''column displays the provided values.
|-
|| '''Page 2''':

Point toward the '''Provided '''column
|| The provided values are higher than the required values.

These values are optimal and ensure the overall economy of the design.
|-
|| '''Page 2''':

Point toward the '''Remarks '''column
|| Finally, a colour-coded remark is made against the check.

Typically, it shows if that particular check has passed or failed.
|-
|| Keep scrolling through page 3 and page 4:

Only narration
|| Similarly, all the checks pertaining to the design are listed with details.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''Min. Pitch Distance (mm) '''in the '''Check '''column
|| Let us interpret a design check.

This check is for the minimum '''pitch '''distance.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''pmin '''in the '''Required '''column
|| The minimum '''pitch '''distance required is 2.5 times the '''bolt '''diameter or greater.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''[Ref. IS 800:2007, Cl.10.2.2] '''in the '''Required '''column
|| The reference clause for this check is mentioned below.

It is based on clause '''10.2.2''' of '''IS 800, 2007'''.
|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''35.0 '''in the '''Required '''column
|| Let us look at the minimum required '''pitch '''distance.

It is calculated as 35 mm for a bolt of 14 mm diameter.

|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''35 '''in the '''Provided '''column
|| The provided value is 35 mm, which is equal to the required value.

|-
|| '''Page 5, Section 2.4, Bolt Design''':

Point toward '''Pass '''in the '''Remarks '''column
|| Thus, the check is marked as '''Pass '''as it satisfies the check condition.
|-
|| Keep scrolling through page 6 to page 11:

Only narration
|| We see that all the checks are carried out in the similar manner.
|-
|| Keep scrolling through page 6 to page 11:

Only narration
|| This makes interpreting the checks very easy.
|-
|| Keep scrolling through page 6 to page 11:

Only narration
|| Novice designers can use this report to learn about the design checks.

They can use it to design a process.
|-
|| '''Page 12''':

Point toward '''3 3D Views '''
|| The 3D and 2D views of the CAD model are also shown as a reference.
|-
|| '''Page 12''':

Only narration
|| We have already seen how to save 3D CAD models in the previous tutorial.
|-
|| '''Page 12''':

Point toward '''Design Logs'''
|| The design '''logs '''pertaining to a design session are also printed.
|-
|| '''Page 12''':

Point toward '''Design Logs'''
|| We can interpret log messages to understand how the design was carried out.

|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide '''

'''Summary'''

|| In this tutorial, we have
* Saved the '''design report '''in Osdag
* Created a user profile
* Interpreted the '''design report'''
* Read the '''IS code''' checks in the '''design report'''

|-
|| '''Slide '''

'''Assignment'''
|| As an '''assignment''', do the following
* Interpret all the checks of the saved design report
* Validate the checks against the values in the '''Output Dock'''

|-
|| '''Slide '''

'''About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide'''

'''Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide'''

'''Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum.
|-
|| '''Slide '''

'''FOSSEE Forum'''
|| For any general or technical questions on '''Osdag''', visit the '''FOSSEE forum''' and post your question.
|-
|| '''Slide '''

'''Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit the link below [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide '''

'''Acknowledgements'''
|| The '''Spoken Tutorial''' project was established by the '''Ministry of Education''', Government of India.
|-
|| '''Slide '''

'''Thank you'''
|| This is Anandajith TS, FOSSEE IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C3/Specifying-design-preferences-in-Osdag/English

2023-10-17T05:36:26Z

Anandajitht:

'''Title of the script:''' Specifying design preferences in Osdag

'''Author''': Anandajith TS

'''Keywords:''' '''Osdag, member design, connection design, steel design optimisation, Tension member, Design Preference, bolt design, detailing, gusset plate, video tutorial'''

{| border=1
|-
|| '''Visual Cue'''
|| Narration
|-
|| '''Slide'''

'''Title Slide'''
|| Welcome to the Spoken Tutorial on '''Specifying design preferences in Osdag.'''
|-
|| '''Slide'''

'''Learning Objectives'''
|| In this tutorial, we will learn to,
* Design preferences in '''Osdag'''
* Define special preferences
* Perform design using special preferences
* Compare the design results

|-
|| '''Slide'''

'''System Requirements'''
|| To record this tutorial, I am using
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide'''

'''Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.

|-
|| '''Slide'''

'''Code Files'''
||

* The files used in this tutorial are available in the '''Code Files'''' link

* Please download and extract them

* Make a copy and then use them while practising

|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Switch to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Point toward the '''Input Dock''' fields
|| I have loaded the '''Preference hyphen sample hyphen design dot OSI '''file.
|-
|| Only narration
|| Please pause the tutorial and perform the same steps on your computer.
|-
|| Click on the '''Design '''button
|| Click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Point toward the '''INFO '''message in the log message window
|| The design is complete and '''safe'''.
|-
|| Point toward the '''CAD window''' and the '''Output Dock'''
|| The '''CAD window''' becomes active, and the '''Output Dock''' is populated with results.
|-
|| Only narration
|| Let us specify some design preferences and check for updated results.
|-
|| '''Slide'''

'''Sample Design Example'''
|| Perform a '''design check''' by adopting the given '''design preferences''':

'''Connector:'''
* '''Material: E300 (Fe 440)'''

'''Bolt:'''
* '''Type: Pre-tensioned'''
* '''Hole Type: Over-sized'''
* '''Slip factor: 0.48'''

|-
|| '''Slide'''

'''Sample Design Example'''
|| '''Detailing:'''
* '''Edge Preparation Method: machine-flame cut'''
* '''Environment: Corrosive'''

'''Design:'''
* '''Limit State Design'''

|-
|| Switch back to '''Tension Member Design - Bolted to End Gusset module '''homepage
|| Performing design with above preferences may change the design results completely.
|-
|| Only narration
|| '''Design Preference''' is an advanced feature.

It should be used after due consideration.
|-
|| Click on the '''Spacing Details button.'''
|| Click the '''Spacing Details button '''under '''End Connection '''in the '''Output Dock'''.
|-
|| Point toward the '''Spacing Details '''window
|| The '''Spacing Details '''window opens.
|-
|| Point toward '''Bolt Rows (nos)'''
|| Notice that the number of '''Bolt Rows''' is 2 on each '''gusset plate'''.
|-
|| Point toward '''Bolt Columns (nos)'''
|| And the number of '''Bolt Columns''' is 16.
|-
|| Only narration
|| This means that there are 32 bolts on each '''gusset plate '''or 16 bolts per '''Angle'''.
|-
|| Only narration
|| Let us see if the bolt configuration changes after designing with special preferences.
|-
|| Click on the close button
|| Click on the close button at the top right corner to exit the window.
|-
|| Point toward '''Capacity (kN)''' under '''Bolt Details''' output
|| Also, notice the''' bolt capacity''' for the given design.

It is '''18.78 kN''' as of now.
|-
|| Only narration
|| Let us see if the '''bolt capacity''' changes after designing with special preferences.
|-
|| Only narration
|| Let us now define the preferences for our design.
|-
|| Click on the '''Edit '''menu in the menu bar
|| Click on the '''Edit '''menu in the menu bar and
|-
|| Select '''Design Preferences '''
|| Select '''Design Preferences '''from the list.
|-
|| Point toward the '''Design Preference''' window
|| The '''Design Preference''' window will open.
|-
|| Only narration
|| The '''Design Preference''' window is categorised into various sections.
|-
|| Click on '''Angle Section'''
|| Typically, these sections include;* Details of the selected member.

|-
|| Click on '''Connector'''
||
* Connector preferences.

|-
|| Click on '''Bolt'''
||
* Bolt preferences.

|-
|| Click on '''Detailing'''
||
* Detailing preferences, and

|-
|| Click on '''Design'''
||
* The design method preference.

|-
|| Only narration
|| Let's explore the sections and define the corresponding preferences individually.
|-
|| Click on the '''Angle Section''' tab
|| Click on the '''Angle Section''' tab to view the selected member details.
|-
|| Point toward '''Designation''', '''Section Profile''' and '''Conn_Location'''
|| Here, section details like '''designation '''and the profile are shown.
|-
|| Point toward '''Mechanical Properties'''
|| Below section details, we see '''Mechanical Properties.'''
|-
|| Point to the properties.
|| These properties get populated based on inputs in the '''Input Dock '''and the codal provisions
|-
|| Point to Angle properties.
|| We will keep the '''Angle '''properties unchanged.
|-
|| Point toward '''Dimensions'''
|| Dimensions of the selected section are listed under the '''Dimensions''' section.
|-
|| Point to the dimensions.
|| These dimensions are fetched from the '''Indian Standard, IS 808''' database of '''Osdag'''
|-
|| Point toward the section image
|| A detailed and representative '''cross-section''' drawing of the selected section is shown.
|-
|| point to the 2D drawing.
|| This 2D drawing is typical and has standard notations marked over it for better visualisation.
|-
|| Point toward '''Section Properties'''
|| The sectional properties corresponding to the selected section are listed under '''Section Properties.'''
|-
|| Point toward '''Section Properties '''fields
|| These properties are also fetched from the '''Osdag '''database at run-time.
|-
|| Only narration
|| For a user-defined section not present in the database, properties are calculated by '''Osdag '''internally.
|-
|| Only narration
|| The properties of this user-defined section are inserted into the database for reuse.
|-
|| Only narration
|| Users can add single or multiple custom sections to the '''Osdag '''database and use it in design.
|-
|| Point toward '''Add '''button
|| The '''Add '''button at the bottom allows to Add a single custom section to the database.
|-
|| Point toward the '''Download xlsx file, '''and '''Import xlsx file '''button
||For adding multiple sections at once using an excel sheet, use the '''Download '''and '''Import xlsx '''buttons.
|-
|| Only narration
|| We will explore this feature in another tutorial.
|-
|| Point toward the '''Clear '''button
|| The '''Clear '''button will clear the user-defined inputs in the Design Preference window.
|-
|| Click on the '''Connector '''tab
|| Let us move to the '''Connector '''tab.
|-
|| Point toward the '''Inputs '''fields
|| Here, we see the '''Material '''properties of the '''connector '''material.
|-
|| Point toward the '''Material drop-down menu'''
|| '''E 250 (Fe 410 W)A''' is selected by default.
|-
|| Point toward the '''Ultimate Strength''' and '''Yield Strength''' field
|| The corresponding values of the ultimate and yield strengths are shown below.
|-
|| Point to the material grade.
|| We need to change the material grade to '''E300'''.
|-
|| Click on the '''Material drop-down menu '''and select '''E300 (Fe 440)''' from the list
|| Click on the '''Material drop-down menu '''and select '''E300 (Fe 440)''' from the list.
|-
|| Point toward the '''Ultimate Strength''' and '''Yield Strength''' field
|| Notice the values of the ultimate and yield strength are now updated automatically.
|-
|| Click on the '''Bolt '''tab
|| Let us now move to the '''Bolt '''tab.
|-
|| Point toward '''Type '''and '''Hole Type'''
|| The default bolt type is '''Pre-tensioned,''' and the '''Hole Type''' is '''Standard'''.
|-
|| Point to the Hole type.
|| The desired Hole Type is '''Over-sized'''.
|-
|| Click on the '''Hole Type drop-down menu '''and select '''Over-sized''' from the list
|| Click on the '''Hole Type drop-down menu '''and select '''Over-sized''' from the list.
|-
|| Point to the slip factor value.
|| Now, let us change the '''Slip factor''' to '''0.48.'''
|-
|| Click on the '''Slip factor drop-down menu, '''scroll and select '''0.48''' from the list
|| Click on the '''Slip factor drop-down menu'''

Scroll down the list and select '''0.48'''.
|-
|| Point toward the '''Description text box'''
|| A description of the slip factor values is shown in the '''Description text box.'''
|-
|| Highlight '''IS 800 Table 20'''
|| The description is referred from the '''Indian Standard, IS 800, Table 20'''.
|-
|| Highlight '''xi) Sand blasted surface 0.48''' in the '''Description text box'''
|| We see, for a slip factor of 0.48, the surface treatment is of '''Sand blasted''' type.
|-
|| Point to the bolt preferences.
|| We have defined preferences for the '''Bolt'''.
|-
|| Click on the '''Detailing '''tab
|| Let us now move to the '''Detailing '''tab.
|-
|| Click on the '''Edge Preparation Method drop-down menu '''and select '''machine-flame cut''' from the list
|| Click on the '''Edge Preparation Method drop-down menu '''and select '''machine-flame cut''' from the list.
|-
|| Point toward the '''Gap '''textbox
|| The '''Gap '''preference is not applicable here. We will leave it as default.
|-
|| Only narration
|| In our design, the members are exposed to corrosive influences.

We need to incorporate this condition in the design.
|-
|| Point toward the '''Are the Members Exposed to Corrosive Influences drop-down''' menu
|| Click on the '''Corrosive Influences drop-down''' menu and select '''Yes'''.
|-
|| Point toward the '''Description text box'''
|| The '''Description text box '''shows a description with reference to the corresponding '''IS 800 clauses'''
|-
|| Only narration
|| Users may refer to this description for a better understanding of these design clauses.
|-
|| Click on the '''Design '''tab
|| Let us now move to the '''Design '''tab.
|-
|| Point toward the '''Design Method''' '''drop-down''' menu
|| We see the default '''Design Method '''is '''Limit State Design.'''
|-
|| Only narration
|| Osdag performs design using the '''Limit State Method.'''
|-
|| Click on the '''Design Method drop-down''' menu
|| Other methods of design are not available with this version.
|-
|| Only narration
|| We have defined all the preferences.

We
are now ready to perform the design.
|-
|| Point toward the '''Defaults '''button
|| The '''Defaults '''button below sets the preferences to the default value.

Do not press this button after defining the preferences.
|-
|| Point toward the '''Save '''button
|| The '''Save '''button saves the defined preferences.
|-
|| Click on the '''Save '''button
|| Click on the '''Save '''button to save and exit the '''Design Preferences''' window.
|-
|| Only narration
|| We are ready to perform the design with saved preferences.
|-
|| Click on the Design button
|| Click on the '''Design '''button again.
|-
|| Only narration
|| Osdag carries out the design.
|-
|| Only narration
|| The design process might take some time to complete.
|-
|| Point toward the '''INFO '''message in the log message window
|| The design is completed successfully.
|-
|| Only narration
|| Now, let us check if the design results have changed from that recorded previously
|-
|| Click on the '''Spacing Details button.'''
|| Click on the '''Spacing Details button '''in the '''Output Dock '''under '''End Connection'''.
|-
|| Point toward '''Bolt Rows (nos)'''
|| The number of '''Bolt Rows''' is 2 on each '''gusset plate'''.
|-
|| Only narration
|| This has not changed.
|-
|| Point toward '''Bolt Columns (nos)'''
|| The number of '''Bolt Columns''' is now 12.
|-
|| Only narration
|| This has been reduced from 16 to 12.
|-
|| Only narration
|| This means that now there are 24 bolts on each '''gusset plate '''or 12 bolts per '''Angle'''.
|-
|| Only narration
|| There is a change in the total number of bolts after designing with special preferences.
|-
|| Click on the close button
|| Click on the close button at the top right corner to exit the window.
|-
|| Point toward '''Capacity (kN)''' under '''Bolt Details''' output
|| Also, notice the''' bolt capacity''' has changed to 26.98 '''kN'''.
|-
|| Only narration
|| Users can refer to other design outputs and compare the results similarly.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have:
* Learnt design preferences in '''Osdag'''
* Defined special preferences
* Performed design using special preferences
* Compared the design results

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following

* Go to the '''Tension Member Design - Welded to End Gusset module'''
* Use the same input values as this tutorial wherever applicable
* Explore and define various '''design preferences'''
* Compare the results and make conclusions

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum.
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
*For more details, please visit this link
[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project was established by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is Anandajith TS, FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Handling-3D-models-and-CAD-in-Osdag/English

2023-10-12T07:54:18Z

Anandajitht:

'''Title of the script:''' Handling 3D models and CAD in Osdag

'''Author''': Zahran Sajid (script), Anandajith TS (recording)

'''Keywords: Osdag, member design, connection design, steel design optimisation, tension member, IS 800, CAD Model, FreeCAD, IGS, STEP, STL, BREP, video tutorial'''

{| border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide: Title Slide'''
|| Welcome to the spoken tutorial on ‘'''Handling 3D models and CAD in Osdag’'''
|-
|| '''Slide: Learning Objectives'''
|| In this tutorial, we will learn to,
* Handle '''3D''' '''CAD model''' in '''Osdag'''
* '''Export '''a '''CAD model''' from '''Osdag '''in standard file formats
* '''Import '''and view the '''CAD model''' in '''FreeCAD'''

|-
|| '''Slide: System Requirement'''
|| To record this tutorial, I am using
* '''Windows 11'''
* '''Osdag '''version '''v2021.02.a.a12f''', and
* '''FreeCAD '''version '''0.20'''

|-
|| '''Slide: Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''
* Basic knowledge of any '''CAD '''manipulation software

The prerequisite''' '''tutorials are available on this website
|-
|| '''Slide: Code Files'''
||
* The files used in this tutorial are available in the '''Code Files''' link
* Please download and extract them
* Make a copy and then use them while practising

|-
|| Point to the '''home page''' of the '''Tension Member Design >>''' Select '''Bolted to End Gusset module.'''
|| Let us switch to the '''home page''' of the '''Tension Member Design.'''

Select '''Bolted to End Gusset module.'''

Click on '''Start.'''
|-
|| Click on '''File '''-> '''Load Input''' and select '''3Dmodel-sample-design.OSI'''

Click on the '''Design '''button

Click on the disable '''Input Dock''' and '''Output Dock''' buttons

|| Click on '''File '''-> '''Load Input'''

Select '''3Dmodel-sample-design.OSI'''

Click on the '''Design '''button..

Also, I have disabled '''Input '''and the '''Output Docks '''for a better view of the CAD''' window.'''
|-
|| '''Osdag:'''

Point towards the '''CAD window '''and the '''Log messages window'''
|| We see the '''CAD model''' and '''log messages '''as the design is successful'''.'''
|-
|| '''Osdag:'''

Point towards the '''3D CAD model'''
|| '''Osdag '''provides a '''3D CAD model''' for a better visualisation of the designed component.
|-
|| '''CAD window:'''

Press the left '''mouse button '''and move the '''mouse '''sideways
|| Rotate the '''CAD model''' by pressing the left '''mouse button''' moving it sideways.
|-
|| Only narration
|| This allows us to view the '''model '''from any side in detail.
|-
|| '''CAD window:'''

Scroll the '''mouse''' wheel up two times
|| '''Zoom in '''the '''CAD model''' by scrolling up the '''mouse '''wheel.
|-
|| '''CAD window:'''

Press the mouse wheel to see a 4 sided- arrow.

Press and hold the mouse wheel and Drag the mouse to the right or left.
|| '''Pan '''the '''CAD model''' by pressing the wheel on the '''mouse '''and moving it sideways.
|-
|| Only narration
|| This allows us to view each component of the '''model '''in detail.
|-
|| '''CAD window:'''

Press the mouse wheel to see a 4 sided- arrow.

Press and hold the mouse wheel and Drag the mouse to the right or left.

|| Again, press the wheel on the '''mouse '''and move it sideways to get back to the previous view.
|-
|| '''CAD window:'''

Scroll the '''mouse '''wheel down two times
|| Similarly, '''zoom out '''the '''CAD model''' by scrolling down the '''mouse '''wheel.
|-
|| '''CAD window:'''

Point toward the '''global axis '''
|| The orientation of the '''CAD model '''in the '''global axis''' can be noted from the reference '''axis '''below.
|-
|| '''CAD window:'''

Point toward the global axis at the bottom right corner.
|| The X, Y and Z axis are marked and colour coded for a quick reference.
|-
|| Point toward the '''Front View''', '''Side View''' and the '''Top View''' shortcut buttons
|| The '''2D''' '''view shortcut buttons''' are present''' '''above the '''CAD window'''.

We can see the '''2D '''view of the '''CAD model''' by using the '''2D''' '''view shortcut buttons.'''
|-
|| Click on the '''Front View''' button
|| To see the front view, click on the '''Front View''' '''shortcut button'''.
|-
|| Point to the view using the cursor.
|| We see the front view and it is oriented along the XZ direction of the '''global axis'''.
|-
|| Click on the '''Side View''' button
|| Now, to see the side view, click on the '''Side View''' '''shortcut button'''.
|-
||Point to the view using the cursor.
|| We see the side view and it is oriented along the YZ direction of the '''global axis'''.
|-
|| Click on the '''Top View''' button
|| Similarly, to see the top view, click on the '''Top View shortcut button'''.
|-
||Point to the view using the cursor.
|| We see the top view and it is oriented along the XY direction of the '''global axis'''.
|-
|| Point toward the '''Member''', '''Plate '''and '''Endplate buttons'''
|| We can isolate and view the individual components of the '''3D CAD model.'''

This can be done by using the components '''button checkbox''' above the '''CAD window'''.
|-
|| Click on the '''Member button.'''
|| To isolate and view the member, click on the '''Member button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the member.
|-
|| Click on the '''Plate button'''
|| Now, to view the plate, click on the '''Plate button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the gusset and '''intermittent connection''' plates with bolts.
|-
|| Click on the '''Endplate button'''
|| Similarly, to view the end plate, click on the '''Endplate button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the gusset plate with bolts.
|-
|| '''Rotate''', '''Pan '''and '''Zoom '''the component
|| We can '''Rotate''', '''Pan '''or '''Zoom '''the individual components as well.
|-
|| Click on the '''Model button'''
|| I will click on the '''Model button '''to return to the default view of the model.
|-
|| Click on the '''Graphics '''menu
|| Alternately, we can perform all of the above actions using the '''Graphics '''menu
|-
|| Only Narration
|| However, it is recommended to use the mouse and checkboxes
|-
|| Only Narration
|| '''Osdag '''allows to save the '''3D CAD model''' in various standard '''CAD''' file formats.

Users can import the '''CAD '''files in any standard '''CAD '''manipulation software.
|-
|| Only Narration
|| Thus allowing us to perform various post-processing activities.
|-
|| Only Narration
|| Let us save the '''3D CAD model''' for this '''module'''.
|-
|| '''Bolted to End Gusset GUI:'''

Click on '''File>>''' '''Save 3D model'''
|| To save the generated '''CAD model''', click on the '''File menu''' present at the top left corner.
And, click on the '''Save 3D model '''from the list'''.'''
|-
|| '''Export Window:'''

Point toward the '''Export Window'''
|| The '''Export Window '''will open.
|-
|| '''Export Window:'''

Point toward the '''Save as type dropdown'''
|| We see the '''Save as type dropdown '''below.

It allows us to choose the format in which we wish to save the '''CAD model'''.
|-
|| '''Export Window:'''

Click on '''Save as type dropdown list'''
|| Click on the '''Save as type dropdown list '''to '''expand''' it.
|-
|| '''Save as type dropdown list:'''

Point toward the list
|| We can see the available '''file formats''', these are:
* '''IGS'''
* '''STEP '''
* '''STL''', and
* '''BREP'''

|-
|| Only narration
|| Let us try to save the model in the '''IGS '''file format.
|-
|| '''Save as type dropdown list:'''

Click on the '''IGS '''option
|| Select and click on '''IGS''' to choose it.
|-
|| Only narration
|| Let us now specify a suitable file name.
|-
|| Point toward the '''File name textbox'''
|| This can be done by typing the file name in the '''File name textbox.'''
|-
|| '''File name textbox:'''

Type '''Tension-member-bolted'''
|| I will name the file as '''Tension-member-bolted.'''

You may choose a convenient '''file name '''of your choice.
|-
|| Only narration
|| Let us now choose a suitable directory to save the file.
|-
|| '''Export Window:'''

Choose '''Osdag-workspace directory'''
|| I will choose the '''Osdag hyphen workspace directory '''to save the model.

You may choose a convenient location of your choice.
|-
|| '''Export Window:'''

Click on '''Save'''
|| Click on the '''Save button '''to save the model.
|-
|| '''Information pop-up:'''

Point toward '''Information pop-up'''
|| A confirmation message will be displayed once the model is successfully saved.
|-
|| '''Information pop-up:'''

Click on '''Ok'''
|| Click on '''Ok '''to acknowledge.
|-
|| Only narration
|| Let us now '''import '''the '''CAD model''' and do some post-processing.
|-
|| Only narration
|| For this, I will use '''FreeCAD'''.

Users can use '''AutoCAD '''or any other software of their choice.
|-
|| '''FreeCAD GUI:'''
|| I have opened '''FreeCAD.'''
|-
|| '''FreeCAD GUI:'''

Click on '''File>>''' '''New'''
|| Go to the '''File menu''' present at the top left corner, and select '''New.'''
|-
|| Only Narration
|| A new '''FreeCAD application window '''will open.

Let us now import the saved '''CAD''' model.
|-
|| '''FreeCAD GUI:'''

Click on '''File>>''' '''Import'''
|| Go to the '''File menu''' present at the top left corner, and select '''Import.'''
|-
|| '''Import File Window:'''

Navigate to '''Osdag_workspace directory'''
|| Click once on the '''Osdag hyphen workspace directory''' where I have saved the model.
|-
|| '''Import File Window:'''

Click on '''Tension_member_bolted.igs'''
|| Click once on the '''Tension hyphen member hyphen bolted dot igs''' file to select it.
|-
|| '''Import File Window:'''

Click on '''Open'''
|| And, click on the '''Open button '''below'''.'''
|-
|| Only narration

Point to the model.
|| We see the '''CAD model '''in '''FreeCAD.'''
|-
|| '''FreeCAD GUI:'''

Click on '''Front Button'''
|| Click on the '''Front View Button '''present in the toolbar on top of the 3D view window.
|-
|| Only narration
|| We see the front view of the model.
|-
|| '''FreeCAD GUI:'''

Click on '''Top Button'''
|| Similarly, click on the '''Top View Button '''present next to the '''Front View Button.'''
|-
|| Only narration
|| We see the top view of the model.
|-
|| '''FreeCAD GUI:'''

Click on '''Right Button'''
|| Next, click on the '''Right View Button '''present next to the '''Front View Button.'''
|-
|| Only narration
|| We see the right side view of the model.
|-
|| Only narration
|| Let us measure the dimension of the section using the '''Measure distance tool.'''
|-
|| '''FreeCAD GUI:'''

Scroll up using the scroll wheel
|| Zoom in on the section by scrolling up on the mouse wheel.
|-
|| '''FreeCAD GUI:'''

Press the middle mouse button and move the mouse sideways
|| Pan the model mouse by pressing the middle mouse button and moving it.
|-
|| '''FreeCAD GUI:'''

Click on '''Measure distance tool'''
|| Select the '''measure distance tool '''from the toolbar above the 3D view of the model.
|-
|| '''FreeCAD GUI:'''

Click on top and bottom outer edges of the section on the right
|| While having the '''measure distance tool '''active click on the outer edges of the section on the right.
|-
|| '''FreeCAD GUI:'''

Point to distance value next to section
|| We can see that the depth of the section is measured to be 125 millimetres for LC 125.
|-
|| Only narration
|| We have measured the depth of the section using FreeCAD’s measuring tool.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have
* Handled the '''3D''' '''CAD model''' in '''Osdag'''
* Exported a '''CAD model''' from '''Osdag '''in a standard file format
* Imported and viewed the '''CAD model''' in '''FreeCAD'''

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following
* Explore the Change background option in the Graphics menu
* Save the '''3D''' '''CAD models '''in '''STEP''', '''STL''' and '''BREP '''file formats
* '''Import '''the model in any '''CAD '''manipulation software
* Perform some post-processing activity like measuring the size of the members, etc.

|-
|| '''Slide: About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum.
|-
|| '''Slide: FOSSEE Forum'''
|| For any general or technical questions on '''Osdag''', visit the '''FOSSEE forum''' and post your question.
|-
|| '''Slide: Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit the link below
[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: Acknowledgements'''
|| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education''', Government of India.
|-
|| '''Slide: Thank you'''
|| This is Anandajith TS,FOSSEE, IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C3/Handling-3D-models-and-CAD-in-Osdag/English

2023-10-11T20:27:24Z

Anandajitht:

'''Title of the script:''' Handling 3D models and CAD in Osdag

'''Author''': Zahran Sajid (script), Anandajith TS (recording)

'''Keywords: Osdag, CAD, CAD Model, FreeCAD, video tutorial'''

{| border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide: Title Slide'''
|| Welcome to the spoken tutorial on ‘'''Handling 3D models and CAD in Osdag’'''
|-
|| '''Slide: Learning Objectives'''
|| In this tutorial, we will learn to,
* Handle '''3D''' '''CAD model''' in '''Osdag'''
* '''Export '''a '''CAD model''' from '''Osdag '''in standard file formats
* '''Import '''and view the '''CAD model''' in '''FreeCAD'''

|-
|| '''Slide: System Requirement'''
|| To record this tutorial, I am using
* '''Windows 11'''
* '''Osdag '''version '''v2021.02.a.a12f''', and
* '''FreeCAD '''version '''0.20'''

|-
|| '''Slide: Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''
* Basic knowledge of any '''CAD '''manipulation software

The prerequisite''' '''tutorials are available on this website
|-
|| '''Slide: Code Files'''
||
* The files used in this tutorial are available in the '''Code Files''' link
* Please download and extract them
* Make a copy and then use them while practising

|-
|| Point to the '''home page''' of the '''Tension Member Design >>''' Select '''Bolted to End Gusset module.'''
|| Let us switch to the '''home page''' of the '''Tension Member Design.'''

Select '''Bolted to End Gusset module.'''

Click on '''Start.'''
|-
|| Click on '''File '''-> '''Load Input''' and select '''3Dmodel-sample-design.OSI'''

Click on the '''Design '''button

Click on the disable '''Input Dock''' and '''Output Dock''' buttons

|| Click on '''File '''-> '''Load Input'''

Select '''3Dmodel-sample-design.OSI'''

Click on the '''Design '''button..

Also, I have disabled '''Input '''and the '''Output Docks '''for a better view of the CAD''' window.'''
|-
|| '''Osdag:'''

Point towards the '''CAD window '''and the '''Log messages window'''
|| We see the '''CAD model''' and '''log messages '''as the design is successful'''.'''
|-
|| '''Osdag:'''

Point towards the '''3D CAD model'''
|| '''Osdag '''provides a '''3D CAD model''' for a better visualisation of the designed component.
|-
|| '''CAD window:'''

Press the left '''mouse button '''and move the '''mouse '''sideways
|| Rotate the '''CAD model''' by pressing the left '''mouse button''' moving it sideways.
|-
|| Only narration
|| This allows us to view the '''model '''from any side in detail.
|-
|| '''CAD window:'''

Scroll the '''mouse''' wheel up two times
|| '''Zoom in '''the '''CAD model''' by scrolling up the '''mouse '''wheel.
|-
|| '''CAD window:'''

Press the mouse wheel to see a 4 sided- arrow.

Press and hold the mouse wheel and Drag the mouse to the right or left.
|| '''Pan '''the '''CAD model''' by pressing the wheel on the '''mouse '''and moving it sideways.
|-
|| Only narration
|| This allows us to view each component of the '''model '''in detail.
|-
|| '''CAD window:'''

Press the mouse wheel to see a 4 sided- arrow.

Press and hold the mouse wheel and Drag the mouse to the right or left.

|| Again, press the wheel on the '''mouse '''and move it sideways to get back to the previous view.
|-
|| '''CAD window:'''

Scroll the '''mouse '''wheel down two times
|| Similarly, '''zoom out '''the '''CAD model''' by scrolling down the '''mouse '''wheel.
|-
|| '''CAD window:'''

Point toward the '''global axis '''
|| The orientation of the '''CAD model '''in the '''global axis''' can be noted from the reference '''axis '''below.
|-
|| '''CAD window:'''

Point toward the global axis at the bottom right corner.
|| The X, Y and Z axis are marked and colour coded for a quick reference.
|-
|| Point toward the '''Front View''', '''Side View''' and the '''Top View''' shortcut buttons
|| The '''2D''' '''view shortcut buttons''' are present''' '''above the '''CAD window'''.

We can see the '''2D '''view of the '''CAD model''' by using the '''2D''' '''view shortcut buttons.'''
|-
|| Click on the '''Front View''' button
|| To see the front view, click on the '''Front View''' '''shortcut button'''.
|-
|| Point to the view using the cursor.
|| We see the front view and it is oriented along the XZ direction of the '''global axis'''.
|-
|| Click on the '''Side View''' button
|| Now, to see the side view, click on the '''Side View''' '''shortcut button'''.
|-
||Point to the view using the cursor.
|| We see the side view and it is oriented along the YZ direction of the '''global axis'''.
|-
|| Click on the '''Top View''' button
|| Similarly, to see the top view, click on the '''Top View shortcut button'''.
|-
||Point to the view using the cursor.
|| We see the top view and it is oriented along the XY direction of the '''global axis'''.
|-
|| Point toward the '''Member''', '''Plate '''and '''Endplate buttons'''
|| We can isolate and view the individual components of the '''3D CAD model.'''

This can be done by using the components '''button checkbox''' above the '''CAD window'''.
|-
|| Click on the '''Member button.'''
|| To isolate and view the member, click on the '''Member button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the member.
|-
|| Click on the '''Plate button'''
|| Now, to view the plate, click on the '''Plate button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the gusset and '''intermittent connection''' plates with bolts.
|-
|| Click on the '''Endplate button'''
|| Similarly, to view the end plate, click on the '''Endplate button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the gusset plate with bolts.
|-
|| '''Rotate''', '''Pan '''and '''Zoom '''the component
|| We can '''Rotate''', '''Pan '''or '''Zoom '''the individual components as well.
|-
|| Click on the '''Model button'''
|| I will click on the '''Model button '''to return to the default view of the model.
|-
|| Click on the '''Graphics '''menu
|| Alternately, we can perform all of the above actions using the '''Graphics '''menu
|-
|| Only Narration
|| However, it is recommended to use the mouse and checkboxes
|-
|| Only Narration
|| '''Osdag '''allows to save the '''3D CAD model''' in various standard '''CAD''' file formats.

Users can import the '''CAD '''files in any standard '''CAD '''manipulation software.
|-
|| Only Narration
|| Thus allowing us to perform various post-processing activities.
|-
|| Only Narration
|| Let us save the '''3D CAD model''' for this '''module'''.
|-
|| '''Bolted to End Gusset GUI:'''

Click on '''File>>''' '''Save 3D model'''
|| To save the generated '''CAD model''', click on the '''File menu''' present at the top left corner.
And, click on the '''Save 3D model '''from the list'''.'''
|-
|| '''Export Window:'''

Point toward the '''Export Window'''
|| The '''Export Window '''will open.
|-
|| '''Export Window:'''

Point toward the '''Save as type dropdown'''
|| We see the '''Save as type dropdown '''below.

It allows us to choose the format in which we wish to save the '''CAD model'''.
|-
|| '''Export Window:'''

Click on '''Save as type dropdown list'''
|| Click on the '''Save as type dropdown list '''to '''expand''' it.
|-
|| '''Save as type dropdown list:'''

Point toward the list
|| We can see the available '''file formats''', these are:
* '''IGS'''
* '''STEP '''
* '''STL''', and
* '''BREP'''

|-
|| Only narration
|| Let us try to save the model in the '''IGS '''file format.
|-
|| '''Save as type dropdown list:'''

Click on the '''IGS '''option
|| Select and click on '''IGS''' to choose it.
|-
|| Only narration
|| Let us now specify a suitable file name.
|-
|| Point toward the '''File name textbox'''
|| This can be done by typing the file name in the '''File name textbox.'''
|-
|| '''File name textbox:'''

Type '''Tension-member-bolted'''
|| I will name the file as '''Tension-member-bolted.'''

You may choose a convenient '''file name '''of your choice.
|-
|| Only narration
|| Let us now choose a suitable directory to save the file.
|-
|| '''Export Window:'''

Choose '''Osdag-workspace directory'''
|| I will choose the '''Osdag hyphen workspace directory '''to save the model.

You may choose a convenient location of your choice.
|-
|| '''Export Window:'''

Click on '''Save'''
|| Click on the '''Save button '''to save the model.
|-
|| '''Information pop-up:'''

Point toward '''Information pop-up'''
|| A confirmation message will be displayed once the model is successfully saved.
|-
|| '''Information pop-up:'''

Click on '''Ok'''
|| Click on '''Ok '''to acknowledge.
|-
|| Only narration
|| Let us now '''import '''the '''CAD model''' and do some post-processing.
|-
|| Only narration
|| For this, I will use '''FreeCAD'''.

Users can use '''AutoCAD '''or any other software of their choice.
|-
|| '''FreeCAD GUI:'''
|| I have opened '''FreeCAD.'''
|-
|| '''FreeCAD GUI:'''

Click on '''File>>''' '''New'''
|| Go to the '''File menu''' present at the top left corner, and select '''New.'''
|-
|| Only Narration
|| A new '''FreeCAD application window '''will open.

Let us now import the saved '''CAD''' model.
|-
|| '''FreeCAD GUI:'''

Click on '''File>>''' '''Import'''
|| Go to the '''File menu''' present at the top left corner, and select '''Import.'''
|-
|| '''Import File Window:'''

Navigate to '''Osdag_workspace directory'''
|| Click once on the '''Osdag hyphen workspace directory''' where I have saved the model.
|-
|| '''Import File Window:'''

Click on '''Tension_member_bolted.igs'''
|| Click once on the '''Tension hyphen member hyphen bolted dot igs''' file to select it.
|-
|| '''Import File Window:'''

Click on '''Open'''
|| And, click on the '''Open button '''below'''.'''
|-
|| Only narration

Point to the model.
|| We see the '''CAD model '''in '''FreeCAD.'''
|-
|| '''FreeCAD GUI:'''

Click on '''Front Button'''
|| Click on the '''Front View Button '''present in the toolbar on top of the 3D view window.
|-
|| Only narration
|| We see the front view of the model.
|-
|| '''FreeCAD GUI:'''

Click on '''Top Button'''
|| Similarly, click on the '''Top View Button '''present next to the '''Front View Button.'''
|-
|| Only narration
|| We see the top view of the model.
|-
|| '''FreeCAD GUI:'''

Click on '''Right Button'''
|| Next, click on the '''Right View Button '''present next to the '''Front View Button.'''
|-
|| Only narration
|| We see the right side view of the model.
|-
|| Only narration
|| Let us measure the dimension of the section using the '''Measure distance tool.'''
|-
|| '''FreeCAD GUI:'''

Scroll up using the scroll wheel
|| Zoom in on the section by scrolling up on the mouse wheel.
|-
|| '''FreeCAD GUI:'''

Press the middle mouse button and move the mouse sideways
|| Pan the model mouse by pressing the middle mouse button and moving it.
|-
|| '''FreeCAD GUI:'''

Click on '''Measure distance tool'''
|| Select the '''measure distance tool '''from the toolbar above the 3D view of the model.
|-
|| '''FreeCAD GUI:'''

Click on top and bottom outer edges of the section on the right
|| While having the '''measure distance tool '''active click on the outer edges of the section on the right.
|-
|| '''FreeCAD GUI:'''

Point to distance value next to section
|| We can see that the depth of the section is measured to be 125 millimetres for LC 125.
|-
|| Only narration
|| We have measured the depth of the section using FreeCAD’s measuring tool.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have
* Handled the '''3D''' '''CAD model''' in '''Osdag'''
* Exported a '''CAD model''' from '''Osdag '''in a standard file format
* Imported and viewed the '''CAD model''' in '''FreeCAD'''

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following
* Explore the Change background option in the Graphics menu
* Save the '''3D''' '''CAD models '''in '''STEP''', '''STL''' and '''BREP '''file formats
* '''Import '''the model in any '''CAD '''manipulation software
* Perform some post-processing activity like measuring the size of the members, etc.

|-
|| '''Slide: About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum.
|-
|| '''Slide: FOSSEE Forum'''
|| For any general or technical questions on '''Osdag''', visit the '''FOSSEE forum''' and post your question.
|-
|| '''Slide: Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit the link below
[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: Acknowledgements'''
|| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education''', Government of India.
|-
|| '''Slide: Thank you'''
|| This is Anandajith TS,FOSSEE, IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C3/Specifying-design-preferences-in-Osdag/English

2023-10-06T09:30:25Z

Anandajitht:

'''Title of the script:''' Specifying design preferences in Osdag

'''Author''': Anandajith TS

'''Keywords:''' '''Osdag, member design, connection design, steel design optimisation, Tension member, Design Preference, bolt design, detailing, gusset plate, video tutorial'''

'''Outline: '''
* Perform the design
* View log messages
* Review design results
* Explore '''Design Preferences'''
* Define '''Member '''preferences
* About custom sections
* Define '''Connector '''preferences
* Define '''Bolt '''preferences
* Define '''Detailing '''preferences
* Perform design using special preferences
* Compare output results

{| border=1
|-
|| '''Visual Cue'''
|| Narration
|-
|| '''Slide'''

'''Title Slide'''
|| Welcome to the Spoken Tutorial on '''Specifying design preferences in Osdag.'''
|-
|| '''Slide'''

'''Learning Objectives'''
|| In this tutorial, we will learn to,
* Design preferences in '''Osdag'''
* Define special preferences
* Perform design using special preferences
* Compare the design results

|-
|| '''Slide'''

'''System Requirements'''
|| To record this tutorial, I am using
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide'''

'''Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.

|-
|| '''Slide'''

'''Code Files'''
||

* The files used in this tutorial are available in the '''Code Files'''' link

* Please download and extract them

* Make a copy and then use them while practising

|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Switch to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Point toward the '''Input Dock''' fields
|| I have loaded the '''Preference hyphen sample hyphen design dot OSI '''file.
|-
|| Only narration
|| Please pause the tutorial and perform the same steps on your computer.
|-
|| Click on the '''Design '''button
|| Click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Point toward the '''INFO '''message in the log message window
|| The design is complete and '''safe'''.
|-
|| Point toward the '''CAD window''' and the '''Output Dock'''
|| The '''CAD window''' becomes active, and the '''Output Dock''' is populated with results.
|-
|| Only narration
|| Let us specify some design preferences and check for updated results.
|-
|| '''Slide'''

'''Sample Design Example'''
|| Perform a '''design check''' by adopting the given '''design preferences''':

'''Connector:'''
* '''Material: E300 (Fe 440)'''

'''Bolt:'''
* '''Type: Pre-tensioned'''
* '''Hole Type: Over-sized'''
* '''Slip factor: 0.48'''

|-
|| '''Slide'''

'''Sample Design Example'''
|| '''Detailing:'''
* '''Edge Preparation Method: machine-flame cut'''
* '''Environment: Corrosive'''

'''Design:'''
* '''Limit State Design'''

|-
|| Switch back to '''Tension Member Design - Bolted to End Gusset module '''homepage
|| Performing design with above preferences may change the design results completely.
|-
|| Only narration
|| '''Design Preference''' is an advanced feature.

It should be used after due consideration.
|-
|| Click on the '''Spacing Details button.'''
|| Click the '''Spacing Details button '''under '''End Connection '''in the '''Output Dock'''.
|-
|| Point toward the '''Spacing Details '''window
|| The '''Spacing Details '''window opens.
|-
|| Point toward '''Bolt Rows (nos)'''
|| Notice that the number of '''Bolt Rows''' is 2 on each '''gusset plate'''.
|-
|| Point toward '''Bolt Columns (nos)'''
|| And the number of '''Bolt Columns''' is 16.
|-
|| Only narration
|| This means that there are 32 bolts on each '''gusset plate '''or 16 bolts per '''Angle'''.
|-
|| Only narration
|| Let us see if the bolt configuration changes after designing with special preferences.
|-
|| Click on the close button
|| Click on the close button at the top right corner to exit the window.
|-
|| Point toward '''Capacity (kN)''' under '''Bolt Details''' output
|| Also, notice the''' bolt capacity''' for the given design.

It is '''18.78 kN''' as of now.
|-
|| Only narration
|| Let us see if the '''bolt capacity''' changes after designing with special preferences.
|-
|| Only narration
|| Let us now define the preferences for our design.
|-
|| Click on the '''Edit '''menu in the menu bar
|| Click on the '''Edit '''menu in the menu bar and
|-
|| Select '''Design Preferences '''
|| Select '''Design Preferences '''from the list.
|-
|| Point toward the '''Design Preference''' window
|| The '''Design Preference''' window will open.
|-
|| Only narration
|| The '''Design Preference''' window is categorised into various sections.
|-
|| Click on '''Angle Section'''
|| Typically, these sections include;* Details of the selected member.

|-
|| Click on '''Connector'''
||
* Connector preferences.

|-
|| Click on '''Bolt'''
||
* Bolt preferences.

|-
|| Click on '''Detailing'''
||
* Detailing preferences, and

|-
|| Click on '''Design'''
||
* The design method preference.

|-
|| Only narration
|| Let's explore the sections and define the corresponding preferences individually.
|-
|| Click on the '''Angle Section''' tab
|| Click on the '''Angle Section''' tab to view the selected member details.
|-
|| Point toward '''Designation''', '''Section Profile''' and '''Conn_Location'''
|| Here, section details like '''designation '''and the profile are shown.
|-
|| Point toward '''Mechanical Properties'''
|| Below section details, we see '''Mechanical Properties.'''
|-
|| Point to the properties.
|| These properties get populated based on inputs in the '''Input Dock '''and the codal provisions
|-
|| Point to Angle properties.
|| We will keep the '''Angle '''properties unchanged.
|-
|| Point toward '''Dimensions'''
|| Dimensions of the selected section are listed under the '''Dimensions''' section.
|-
|| Point to the dimensions.
|| These dimensions are fetched from the '''Indian Standard, IS 808''' database of '''Osdag'''
|-
|| Point toward the section image
|| A detailed and representative '''cross-section''' drawing of the selected section is shown.
|-
|| point to the 2D drawing.
|| This 2D drawing is typical and has standard notations marked over it for better visualisation.
|-
|| Point toward '''Section Properties'''
|| The sectional properties corresponding to the selected section are listed under '''Section Properties.'''
|-
|| Point toward '''Section Properties '''fields
|| These properties are also fetched from the '''Osdag '''database at run-time.
|-
|| Only narration
|| For a user-defined section not present in the database, properties are calculated by '''Osdag '''internally.
|-
|| Only narration
|| The properties of this user-defined section are inserted into the database for reuse.
|-
|| Only narration
|| Users can add single or multiple custom sections to the '''Osdag '''database and use it in design.
|-
|| Point toward '''Add '''button
|| The '''Add '''button at the bottom allows to Add a single custom section to the database.
|-
|| Point toward the '''Download xlsx file, '''and '''Import xlsx file '''button
||For adding multiple sections at once using an excel sheet, use the '''Download '''and '''Import xlsx '''buttons.
|-
|| Only narration
|| We will explore this feature in another tutorial.
|-
|| Point toward the '''Clear '''button
|| The '''Clear '''button will clear the user-defined inputs in the Design Preference window.
|-
|| Click on the '''Connector '''tab
|| Let us move to the '''Connector '''tab.
|-
|| Point toward the '''Inputs '''fields
|| Here, we see the '''Material '''properties of the '''connector '''material.
|-
|| Point toward the '''Material drop-down menu'''
|| '''E 250 (Fe 410 W)A''' is selected by default.
|-
|| Point toward the '''Ultimate Strength''' and '''Yield Strength''' field
|| The corresponding values of the ultimate and yield strengths are shown below.
|-
|| Point to the material grade.
|| We need to change the material grade to '''E300'''.
|-
|| Click on the '''Material drop-down menu '''and select '''E300 (Fe 440)''' from the list
|| Click on the '''Material drop-down menu '''and select '''E300 (Fe 440)''' from the list.
|-
|| Point toward the '''Ultimate Strength''' and '''Yield Strength''' field
|| Notice the values of the ultimate and yield strength are now updated automatically.
|-
|| Click on the '''Bolt '''tab
|| Let us now move to the '''Bolt '''tab.
|-
|| Point toward '''Type '''and '''Hole Type'''
|| The default bolt type is '''Pre-tensioned,''' and the '''Hole Type''' is '''Standard'''.
|-
|| Point to the Hole type.
|| The desired Hole Type is '''Over-sized'''.
|-
|| Click on the '''Hole Type drop-down menu '''and select '''Over-sized''' from the list
|| Click on the '''Hole Type drop-down menu '''and select '''Over-sized''' from the list.
|-
|| Point to the slip factor value.
|| Now, let us change the '''Slip factor''' to '''0.48.'''
|-
|| Click on the '''Slip factor drop-down menu, '''scroll and select '''0.48''' from the list
|| Click on the '''Slip factor drop-down menu'''

Scroll down the list and select '''0.48'''.
|-
|| Point toward the '''Description text box'''
|| A description of the slip factor values is shown in the '''Description text box.'''
|-
|| Highlight '''IS 800 Table 20'''
|| The description is referred from the '''Indian Standard, IS 800, Table 20'''.
|-
|| Highlight '''xi) Sand blasted surface 0.48''' in the '''Description text box'''
|| We see, for a slip factor of 0.48, the surface treatment is of '''Sand blasted''' type.
|-
|| Point to the bolt preferences.
|| We have defined preferences for the '''Bolt'''.
|-
|| Click on the '''Detailing '''tab
|| Let us now move to the '''Detailing '''tab.
|-
|| Click on the '''Edge Preparation Method drop-down menu '''and select '''machine-flame cut''' from the list
|| Click on the '''Edge Preparation Method drop-down menu '''and select '''machine-flame cut''' from the list.
|-
|| Point toward the '''Gap '''textbox
|| The '''Gap '''preference is not applicable here. We will leave it as default.
|-
|| Only narration
|| In our design, the members are exposed to corrosive influences.

We need to incorporate this condition in the design.
|-
|| Point toward the '''Are the Members Exposed to Corrosive Influences drop-down''' menu
|| Click on the '''Corrosive Influences drop-down''' menu and select '''Yes'''.
|-
|| Point toward the '''Description text box'''
|| The '''Description text box '''shows a description with reference to the corresponding '''IS 800 clauses'''
|-
|| Only narration
|| Users may refer to this description for a better understanding of these design clauses.
|-
|| Click on the '''Design '''tab
|| Let us now move to the '''Design '''tab.
|-
|| Point toward the '''Design Method''' '''drop-down''' menu
|| We see the default '''Design Method '''is '''Limit State Design.'''
|-
|| Only narration
|| Osdag performs design using the '''Limit State Method.'''
|-
|| Click on the '''Design Method drop-down''' menu
|| Other methods of design are not available with this version.
|-
|| Only narration
|| We have defined all the preferences.

We
are now ready to perform the design.
|-
|| Point toward the '''Defaults '''button
|| The '''Defaults '''button below sets the preferences to the default value.

Do not press this button after defining the preferences.
|-
|| Point toward the '''Save '''button
|| The '''Save '''button saves the defined preferences.
|-
|| Click on the '''Save '''button
|| Click on the '''Save '''button to save and exit the '''Design Preferences''' window.
|-
|| Only narration
|| We are ready to perform the design with saved preferences.
|-
|| Click on the Design button
|| Click on the '''Design '''button again.
|-
|| Only narration
|| Osdag carries out the design.
|-
|| Only narration
|| The design process might take some time to complete.
|-
|| Point toward the '''INFO '''message in the log message window
|| The design is completed successfully.
|-
|| Only narration
|| Now, let us check if the design results have changed from that recorded previously
|-
|| Click on the '''Spacing Details button.'''
|| Click on the '''Spacing Details button '''in the '''Output Dock '''under '''End Connection'''.
|-
|| Point toward '''Bolt Rows (nos)'''
|| The number of '''Bolt Rows''' is 2 on each '''gusset plate'''.
|-
|| Only narration
|| This has not changed.
|-
|| Point toward '''Bolt Columns (nos)'''
|| The number of '''Bolt Columns''' is now 12.
|-
|| Only narration
|| This has been reduced from 16 to 12.
|-
|| Only narration
|| This means that now there are 24 bolts on each '''gusset plate '''or 12 bolts per '''Angle'''.
|-
|| Only narration
|| There is a change in the total number of bolts after designing with special preferences.
|-
|| Click on the close button
|| Click on the close button at the top right corner to exit the window.
|-
|| Point toward '''Capacity (kN)''' under '''Bolt Details''' output
|| Also, notice the''' bolt capacity''' has changed to 26.98 '''kN'''.
|-
|| Only narration
|| Users can refer to other design outputs and compare the results similarly.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have:
* Learnt design preferences in '''Osdag'''
* Defined special preferences
* Performed design using special preferences
* Compared the design results

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following

* Go to the '''Tension Member Design - Welded to End Gusset module'''
* Use the same input values as this tutorial wherever applicable
* Explore and define various '''design preferences'''
* Compare the results and make conclusions

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum.
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
*For more details, please visit this link
[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project was established by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is Anandajith TS, FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Specifying-design-preferences-in-Osdag/English

2023-09-26T06:10:25Z

Anandajitht: Created page with "'''Title of the script:''' Specifying design preferences in Osdag '''Author''': Anandajith TS '''Keywords:''' '''Osdag, member design, connection design, steel design optimi..."

'''Title of the script:''' Specifying design preferences in Osdag

'''Author''': Anandajith TS

'''Keywords:''' '''Osdag, member design, connection design, steel design optimisation, Tension member, Design Preference, bolt design, detailing, gusset plate, video tutorial'''

'''Outline: '''
* Perform the design
* View log messages
* Review design results
* Explore '''Design Preferences'''
* Define '''Member '''preferences
* About custom sections
* Define '''Connector '''preferences
* Define '''Bolt '''preferences
* Define '''Detailing '''preferences
* Perform design using special preferences
* Compare output results

{| border=1
|-
|| '''Visual Cue'''
|| Narration
|-
|| '''Slide'''

'''Title Slide'''
|| Welcome to the Spoken Tutorial on '''Specifying design preferences in Osdag.'''
|-
|| '''Slide'''

'''Learning Objectives'''
|| In this tutorial, we will learn to,
* Design preferences in '''Osdag'''
* Define special preferences
* Perform design using special preferences
* Compare the design results

|-
|| '''Slide'''

'''System Requirements'''
|| To record this tutorial, I am using
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide'''

'''Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Switch to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Point toward the '''Input Dock''' fields
|| I have loaded the '''Preference hyphen sample hyphen design dot OSI '''file.
|-
|| Only narration
|| Please pause the tutorial and perform the same steps on your computer.
|-
|| Click on the '''Design '''button
|| Click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Point toward the '''INFO '''message in the log message window
|| The design is complete and '''safe'''.
|-
|| Point toward the '''CAD window''' and the '''Output Dock'''
|| The '''CAD window''' becomes active, and the '''Output Dock''' is populated with results.
|-
|| Only narration
|| Let us specify some design preferences and check for updated results.
|-
|| '''Slide'''

'''Sample Design Example'''
|| Perform a '''design check''' by adopting the given '''design preferences''':

'''Connector:'''
* '''Material: E300 (Fe 440)'''

'''Bolt:'''
* '''Type: Pre-tensioned'''
* '''Hole Type: Over-sized'''
* '''Slip factor: 0.48'''

|-
|| '''Slide'''

'''Sample Design Example'''
|| '''Detailing:'''
* '''Edge Preparation Method: machine-flame cut'''
* '''Environment: Corrosive'''

'''Design:'''
* '''Limit State Design'''

|-
|| Switch back to '''Tension Member Design - Bolted to End Gusset module '''homepage
|| Performing design with above preferences may change the design results completely.
|-
|| Only narration
|| '''Design Preference''' is an advanced feature.

It should be used after due consideration.
|-
|| Click on the '''Spacing Details button.'''
|| Click the '''Spacing Details button '''under '''End Connection '''in the '''Output Dock'''.
|-
|| Point toward the '''Spacing Details '''window
|| The '''Spacing Details '''window opens.
|-
|| Point toward '''Bolt Rows (nos)'''
|| Notice that the number of '''Bolt Rows''' is 2 on each '''gusset plate'''.
|-
|| Point toward '''Bolt Columns (nos)'''
|| And the number of '''Bolt Columns''' is 16.
|-
|| Only narration
|| This means that there are 32 bolts on each '''gusset plate '''or 16 bolts per '''Angle'''.
|-
|| Only narration
|| Let us see if the bolt configuration changes after designing with special preferences.
|-
|| Click on the close button
|| Click on the close button at the top right corner to exit the window.
|-
|| Point toward '''Capacity (kN)''' under '''Bolt Details''' output
|| Also, notice the''' bolt capacity''' for the given design.

It is '''18.78 kN''' as of now.
|-
|| Only narration
|| Let us see if the '''bolt capacity''' changes after designing with special preferences.
|-
|| Only narration
|| Let us now define the preferences for our design.
|-
|| Click on the '''Edit '''menu in the menu bar
|| Click on the '''Edit '''menu in the menu bar and
|-
|| Select '''Design Preferences '''
|| Select '''Design Preferences '''from the list.
|-
|| Point toward the '''Design Preference''' window
|| The '''Design Preference''' window will open.
|-
|| Only narration
|| The '''Design Preference''' window is categorised into various sections.
|-
|| Click on '''Angle Section'''
|| Typically, these sections include;* Details of the selected member.

|-
|| Click on '''Connector'''
||
* Connector preferences.

|-
|| Click on '''Bolt'''
||
* Bolt preferences.

|-
|| Click on '''Detailing'''
||
* Detailing preferences, and

|-
|| Click on '''Design'''
||
* The design method preference.

|-
|| Only narration
|| Let's explore the sections and define the corresponding preferences individually.
|-
|| Click on the '''Angle Section''' tab
|| Click on the '''Angle Section''' tab to view the selected member details.
|-
|| Point toward '''Designation''', '''Section Profile''' and '''Conn_Location'''
|| Here, section details like '''designation '''and the profile are shown.
|-
|| Point toward '''Mechanical Properties'''
|| Below section details, we see '''Mechanical Properties.'''
|-
|| Point to the properties.
|| These properties get populated based on inputs in the '''Input Dock '''and the codal provisions
|-
|| Point to Angle properties.
|| We will keep the '''Angle '''properties unchanged.
|-
|| Point toward '''Dimensions'''
|| Dimensions of the selected section are listed under the '''Dimensions''' section.
|-
|| Point to the dimensions.
|| These dimensions are fetched from the '''Indian Standard, IS 808''' database of '''Osdag'''
|-
|| Point toward the section image
|| A detailed and representative '''cross-section''' drawing of the selected section is shown.
|-
|| point to the 2D drawing.
|| This 2D drawing is typical and has standard notations marked over it for better visualisation.
|-
|| Point toward '''Section Properties'''
|| The sectional properties corresponding to the selected section are listed under '''Section Properties.'''
|-
|| Point toward '''Section Properties '''fields
|| These properties are also fetched from the '''Osdag '''database at run-time.
|-
|| Only narration
|| For a user-defined section not present in the database, properties are calculated by '''Osdag '''internally.
|-
|| Only narration
|| The properties of this user-defined section are inserted into the database for reuse.
|-
|| Only narration
|| Users can add single or multiple custom sections to the '''Osdag '''database and use it in design.
|-
|| Point toward '''Add '''button
|| The '''Add '''button at the bottom allows to Add a single custom section to the database.
|-
|| Point toward the '''Download xlsx file, '''and '''Import xlsx file '''button
||For adding multiple sections at once using an excel sheet, use the '''Download '''and '''Import xlsx '''buttons.
|-
|| Only narration
|| We will explore this feature in another tutorial.
|-
|| Point toward the '''Clear '''button
|| The '''Clear '''button will clear the user-defined inputs in the Design Preference window.
|-
|| Click on the '''Connector '''tab
|| Let us move to the '''Connector '''tab.
|-
|| Point toward the '''Inputs '''fields
|| Here, we see the '''Material '''properties of the '''connector '''material.
|-
|| Point toward the '''Material drop-down menu'''
|| '''E 250 (Fe 410 W)A''' is selected by default.
|-
|| Point toward the '''Ultimate Strength''' and '''Yield Strength''' field
|| The corresponding values of the ultimate and yield strengths are shown below.
|-
|| Point to the material grade.
|| We need to change the material grade to '''E300'''.
|-
|| Click on the '''Material drop-down menu '''and select '''E300 (Fe 440)''' from the list
|| Click on the '''Material drop-down menu '''and select '''E300 (Fe 440)''' from the list.
|-
|| Point toward the '''Ultimate Strength''' and '''Yield Strength''' field
|| Notice the values of the ultimate and yield strength are now updated automatically.
|-
|| Click on the '''Bolt '''tab
|| Let us now move to the '''Bolt '''tab.
|-
|| Point toward '''Type '''and '''Hole Type'''
|| The default bolt type is '''Pre-tensioned,''' and the '''Hole Type''' is '''Standard'''.
|-
|| Point to the Hole type.
|| The desired Hole Type is '''Over-sized'''.
|-
|| Click on the '''Hole Type drop-down menu '''and select '''Over-sized''' from the list
|| Click on the '''Hole Type drop-down menu '''and select '''Over-sized''' from the list.
|-
|| Point to the slip factor value.
|| Now, let us change the '''Slip factor''' to '''0.48.'''
|-
|| Click on the '''Slip factor drop-down menu, '''scroll and select '''0.48''' from the list
|| Click on the '''Slip factor drop-down menu'''

Scroll down the list and select '''0.48'''.
|-
|| Point toward the '''Description text box'''
|| A description of the slip factor values is shown in the '''Description text box.'''
|-
|| Highlight '''IS 800 Table 20'''
|| The description is referred from the '''Indian Standard, IS 800, Table 20'''.
|-
|| Highlight '''xi) Sand blasted surface 0.48''' in the '''Description text box'''
|| We see, for a slip factor of 0.48, the surface treatment is of '''Sand blasted''' type.
|-
|| Point to the bolt preferences.
|| We have defined preferences for the '''Bolt'''.
|-
|| Click on the '''Detailing '''tab
|| Let us now move to the '''Detailing '''tab.
|-
|| Click on the '''Edge Preparation Method drop-down menu '''and select '''machine-flame cut''' from the list
|| Click on the '''Edge Preparation Method drop-down menu '''and select '''machine-flame cut''' from the list.
|-
|| Point toward the '''Gap '''textbox
|| The '''Gap '''preference is not applicable here. We will leave it as default.
|-
|| Only narration
|| In our design, the members are exposed to corrosive influences.

We need to incorporate this condition in the design.
|-
|| Point toward the '''Are the Members Exposed to Corrosive Influences drop-down''' menu
|| Click on the '''Corrosive Influences drop-down''' menu and select '''Yes'''.
|-
|| Point toward the '''Description text box'''
|| The '''Description text box '''shows a description with reference to the corresponding '''IS 800 clauses'''
|-
|| Only narration
|| Users may refer to this description for a better understanding of these design clauses.
|-
|| Click on the '''Design '''tab
|| Let us now move to the '''Design '''tab.
|-
|| Point toward the '''Design Method''' '''drop-down''' menu
|| We see the default '''Design Method '''is '''Limit State Design.'''
|-
|| Only narration
|| Osdag performs design using the '''Limit State Method.'''
|-
|| Click on the '''Design Method drop-down''' menu
|| Other methods of design are not available with this version.
|-
|| Only narration
|| We have defined all the preferences.

We
are now ready to perform the design.
|-
|| Point toward the '''Defaults '''button
|| The '''Defaults '''button below sets the preferences to the default value.

Do not press this button after defining the preferences.
|-
|| Point toward the '''Save '''button
|| The '''Save '''button saves the defined preferences.
|-
|| Click on the '''Save '''button
|| Click on the '''Save '''button to save and exit the '''Design Preferences''' window.
|-
|| Only narration
|| We are ready to perform the design with saved preferences.
|-
|| Click on the Design button
|| Click on the '''Design '''button again.
|-
|| Only narration
|| Osdag carries out the design.
|-
|| Only narration
|| The design process might take some time to complete.
|-
|| Point toward the '''INFO '''message in the log message window
|| The design is completed successfully.
|-
|| Only narration
|| Now, let us check if the design results have changed from that recorded previously
|-
|| Click on the '''Spacing Details button.'''
|| Click on the '''Spacing Details button '''in the '''Output Dock '''under '''End Connection'''.
|-
|| Point toward '''Bolt Rows (nos)'''
|| The number of '''Bolt Rows''' is 2 on each '''gusset plate'''.
|-
|| Only narration
|| This has not changed.
|-
|| Point toward '''Bolt Columns (nos)'''
|| The number of '''Bolt Columns''' is now 12.
|-
|| Only narration
|| This has been reduced from 16 to 12.
|-
|| Only narration
|| This means that now there are 24 bolts on each '''gusset plate '''or 12 bolts per '''Angle'''.
|-
|| Only narration
|| There is a change in the total number of bolts after designing with special preferences.
|-
|| Click on the close button
|| Click on the close button at the top right corner to exit the window.
|-
|| Point toward '''Capacity (kN)''' under '''Bolt Details''' output
|| Also, notice the''' bolt capacity''' has changed to 26.98 '''kN'''.
|-
|| Only narration
|| Users can refer to other design outputs and compare the results similarly.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have:
* Learnt design preferences in '''Osdag'''
* Defined special preferences
* Performed design using special preferences
* Compared the design results

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following

* Go to the '''Tension Member Design - Welded to End Gusset module'''
* Use the same input values as this tutorial wherever applicable
* Explore and define various '''design preferences'''
* Compare the results and make conclusions

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum.
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
*For more details, please visit this link
[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project was established by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is Anandajith TS, FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Handling-3D-models-and-CAD-in-Osdag/English

2023-09-25T19:33:55Z

Anandajitht: Created page with "'''Title of the script:''' Handling 3D models and CAD in Osdag '''Author''': Zahran Sajid (script), Anandajith TS (recording) '''Keywords: Osdag, CAD, CAD Model, FreeCAD, vi..."

'''Title of the script:''' Handling 3D models and CAD in Osdag

'''Author''': Zahran Sajid (script), Anandajith TS (recording)

'''Keywords: Osdag, CAD, CAD Model, FreeCAD, video tutorial'''

'''Outline: '''
* '''Sample design example '''
* Visualise the '''3D CAD model'''
* Hande the '''3D CAD model''': Zoom, Pan and Rotate
* Reference axis of '''CAD '''in '''Osdag'''
* '''2D '''views of the '''CAD model''': Front View, Side View and Top View
* Individual components of the '''3D CAD model'''
* '''CAD '''file formats in '''Osdag'''
* Save the generated '''3D CAD model'''
* Create a new '''FreeCAD Document'''
* Import the '''3D CAD model in FreeCAD'''

{| border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide: Title Slide'''
|| Welcome to the spoken tutorial on ‘'''Handling 3D models and CAD in Osdag’'''
|-
|| '''Slide: Learning Objectives'''
|| In this tutorial, we will learn to,
* Handle '''3D''' '''CAD model''' in '''Osdag'''
* '''Export '''a '''CAD model''' from '''Osdag '''in standard file formats
* '''Import '''and view the '''CAD model''' in '''FreeCAD'''

|-
|| '''Slide: System Requirement'''
|| To record this tutorial, I am using
* '''Windows 11'''
* '''Osdag '''version '''v2021.02.a.a12f''', and
* '''FreeCAD '''version '''0.20'''

|-
|| '''Slide: Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''
* Basic knowledge of any '''CAD '''manipulation software

The prerequisite''' '''tutorials are available on this website
|-
|| '''Slide: Code Files'''
||
* The files used in this tutorial are available in the '''Code Files''' link
* Please download and extract them
* Make a copy and then use them while practising

|-
|| Point to the '''home page''' of the '''Tension Member Design >>''' Select '''Bolted to End Gusset module.'''
|| Let us switch to the '''home page''' of the '''Tension Member Design.'''

Select '''Bolted to End Gusset module.'''

Click on '''Start.'''
|-
|| Click on '''File '''-> '''Load Input''' and select '''3Dmodel-sample-design.OSI'''

Click on the '''Design '''button

Click on the disable '''Input Dock''' and '''Output Dock''' buttons

|| Click on '''File '''-> '''Load Input'''

Select '''3Dmodel-sample-design.OSI'''

Click on the '''Design '''button..

Also, I have disabled '''Input '''and the '''Output Docks '''for a better view of the CAD''' window.'''
|-
|| '''Osdag:'''

Point towards the '''CAD window '''and the '''Log messages window'''
|| We see the '''CAD model''' and '''log messages '''as the design is successful'''.'''
|-
|| '''Osdag:'''

Point towards the '''3D CAD model'''
|| '''Osdag '''provides a '''3D CAD model''' for a better visualisation of the designed component.
|-
|| '''CAD window:'''

Press the left '''mouse button '''and move the '''mouse '''sideways
|| Rotate the '''CAD model''' by pressing the left '''mouse button''' moving it sideways.
|-
|| Only narration
|| This allows us to view the '''model '''from any side in detail.
|-
|| '''CAD window:'''

Scroll the '''mouse''' wheel up two times
|| '''Zoom in '''the '''CAD model''' by scrolling up the '''mouse '''wheel.
|-
|| '''CAD window:'''

Press the mouse wheel to see a 4 sided- arrow.

Press and hold the mouse wheel and Drag the mouse to the right or left.
|| '''Pan '''the '''CAD model''' by pressing the wheel on the '''mouse '''and moving it sideways.
|-
|| Only narration
|| This allows us to view each component of the '''model '''in detail.
|-
|| '''CAD window:'''

Press the mouse wheel to see a 4 sided- arrow.

Press and hold the mouse wheel and Drag the mouse to the right or left.

|| Again, press the wheel on the '''mouse '''and move it sideways to get back to the previous view.
|-
|| '''CAD window:'''

Scroll the '''mouse '''wheel down two times
|| Similarly, '''zoom out '''the '''CAD model''' by scrolling down the '''mouse '''wheel.
|-
|| '''CAD window:'''

Point toward the '''global axis '''
|| The orientation of the '''CAD model '''in the '''global axis''' can be noted from the reference '''axis '''below.
|-
|| '''CAD window:'''

Point toward the global axis at the bottom right corner.
|| The X, Y and Z axis are marked and colour coded for a quick reference.
|-
|| Point toward the '''Front View''', '''Side View''' and the '''Top View''' shortcut buttons
|| The '''2D''' '''view shortcut buttons''' are present''' '''above the '''CAD window'''.

We can see the '''2D '''view of the '''CAD model''' by using the '''2D''' '''view shortcut buttons.'''
|-
|| Click on the '''Front View''' button
|| To see the front view, click on the '''Front View''' '''shortcut button'''.
|-
||

Point to the view using the cursor.
|| We see the front view and it is oriented along the XZ direction of the '''global axis'''.
|-
|| Click on the '''Side View''' button
|| Now, to see the side view, click on the '''Side View''' '''shortcut button'''.
|-
||

Point to the view using the cursor.
|| We see the side view and it is oriented along the YZ direction of the '''global axis'''.
|-
|| Click on the '''Top View''' button
|| Similarly, to see the top view, click on the '''Top View shortcut button'''.
|-
||

Point to the view using the cursor.
|| We see the top view and it is oriented along the XY direction of the '''global axis'''.
|-
|| Point toward the '''Member''', '''Plate '''and '''Endplate buttons'''
|| We can isolate and view the individual components of the '''3D CAD model.'''

This can be done by using the components '''button checkbox''' above the '''CAD window'''.
|-
|| Click on the '''Member button.'''
|| To isolate and view the member, click on the '''Member button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the member.
|-
|| Click on the '''Plate button'''
|| Now, to view the plate, click on the '''Plate button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the gusset and '''intermittent connection''' plates with bolts.
|-
|| Click on the '''Endplate button'''
|| Similarly, to view the end plate, click on the '''Endplate button'''.
|-
|| '''CAD window:'''

Point toward the '''CAD model'''
|| We see an isolated '''CAD model''' of the gusset plate with
|-
|| '''Rotate''', '''Pan '''and '''Zoom '''the component
|| We can '''Rotate''', '''Pan '''or '''Zoom '''the individual components as well.
|-
|| '''CAD window:'''

Press the left '''mouse button '''and move the '''mouse '''sideways
|| Press the left '''mouse button''' and move it sideways to rotate the individual component.
|-
|| Click on the '''Model button'''
|| I will click on the '''Model button '''to return to the default view of the model.
|-
|| Click on the '''Graphics '''menu
|| Alternately, we can perform all of the above actions using the '''Graphics '''menu
|-
|| Only Narration
|| However, it is recommended to use the mouse and checkboxes
|-
|| Only Narration
|| '''Osdag '''allows to save the '''3D CAD model''' in various standard '''CAD''' file formats.

Users can import the '''CAD '''files in any standard '''CAD '''manipulation software.
|-
|| Only Narration
|| Thus allowing us to perform various post-processing activities.
|-
|| Only Narration
|| Let us save the '''3D CAD model''' for this '''module'''.
|-
|| '''Bolted to End Gusset GUI:'''

Click on '''File>>''' '''Save 3D model'''
|| To save the generated '''CAD model''', click on the '''File menu''' present at the top left corner.And, click on the '''Save 3D model '''from the list'''.'''
|-
|| '''Export Window:'''

Point toward the '''Export Window'''
|| The '''Export Window '''will open.
|-
|| '''Export Window:'''

Point toward the '''Save as type dropdown'''
|| We see the '''Save as type dropdown '''below.

It allows us to choose the format in which we wish to save the '''CAD model'''.
|-
|| '''Export Window:'''

Click on '''Save as type dropdown list'''
|| Click on the '''Save as type dropdown list '''to '''expand''' it.
|-
|| '''Save as type dropdown list:'''

Point toward the list
|| We can see the available '''file formats''', these are:
* '''IGS'''
* '''STEP '''
* '''STL''', and
* '''BREP'''

|-
|| Only narration
|| Let us try to save the model in the '''IGS '''file format.
|-
|| '''Save as type dropdown list:'''

Click on the '''IGS '''option
|| Select and click on '''IGS''' to choose it.
|-
|| Only narration
|| Let us now specify a suitable file name.
|-
|| Point toward the '''File name textbox'''
|| This can be done by typing the file name in the '''File name textbox.'''
|-
|| '''File name textbox:'''

Type '''Tension-member-bolted'''
|| I will name the file as '''Tension-member-bolted.'''

You may choose a convenient '''file name '''of your choice.
|-
|| Only narration
|| Let us now choose a suitable directory to save the file.
|-
|| '''Export Window:'''

Choose '''Osdag-workspace directory'''
|| I will choose the '''Osdag hyphen workspace directory '''to save the model.

You may choose a convenient location of your choice.
|-
|| '''Export Window:'''

Click on '''Save'''
|| Click on the '''Save button '''to save the model.
|-
|| '''Information pop-up:'''

Point toward '''Information pop-up'''
|| A confirmation message will be displayed once the model is successfully saved.
|-
|| '''Information pop-up:'''

Click on '''Ok'''
|| Click on '''Ok '''to acknowledge.
|-
|| Only narration
|| Let us now '''import '''the '''CAD model''' and do some post-processing.
|-
|| Only narration
|| For this, I will use '''FreeCAD'''.

Users can use '''AutoCAD '''or any other software of their choice.
|-
|| '''FreeCAD GUI:'''
|| I have opened '''FreeCAD.'''
|-
|| '''FreeCAD GUI:'''

Click on '''File>>''' '''New'''
|| Go to the '''File menu''' present at the top left corner, and select '''New.'''
|-
|| Only Narration
|| A new '''FreeCAD application window '''will open.

Let us now import the saved '''CAD''' model.
|-
|| '''FreeCAD GUI:'''

Click on '''File>>''' '''Import'''
|| Go to the '''File menu''' present at the top left corner, and select '''Import.'''
|-
|| '''Import File Window:'''

Navigate to '''Osdag_workspace directory'''
|| I will open the '''Osdag hyphen underscore workspace directory''' where I have saved the model.
|-
|| '''Import File Window:'''

Click on '''Tension_member_bolted.igs'''
|| Click once on the '''Tension-member-bolted dot igs''' file to select it.
|-
|| '''Import File Window:'''

Click on '''Open'''
|| And, click on the '''Open button '''below'''.'''
|-
|| Only narration

Point to the model.
|| We see the '''CAD model '''in '''FreeCAD.'''
|-
|| '''FreeCAD GUI:'''

Click on '''Front Button'''
|| Click on the '''Front View Button '''present in the toolbar on top of the 3D view window.
|-
|| Only narration
|| We see the front view of the model.
|-
|| '''FreeCAD GUI:'''

Click on '''Top Button'''
|| Similarly, click on the '''Top View Button '''present next to the '''Front View Button.'''
|-
|| Only narration
|| We see the top view of the model.
|-
|| '''FreeCAD GUI:'''

Click on '''Right Button'''
|| Next, click on the '''Right View Button '''present next to the '''Front View Button.'''
|-
|| Only narration
|| We see the right side view of the model.
|-
|| Only narration
|| Let us measure the dimension of the section using the '''Measure distance tool.'''
|-
|| '''FreeCAD GUI:'''

Scroll up using the scroll wheel
|| Zoom in on the section by scrolling up on the mouse wheel.
|-
|| '''FreeCAD GUI:'''

Press the middle mouse button and move the mouse sideways
|| Pan the model mouse by pressing the middle mouse button and moving it.
|-
|| '''FreeCAD GUI:'''

Click on '''Measure distance tool'''
|| Select the '''measure distance tool '''from the toolbar above the 3D view of the model.
|-
|| '''FreeCAD GUI:'''

Click on top and bottom outer edges of the section on the right
|| While having the '''measure distance tool '''active click on the outer edges of the section on the right.
|-
|| '''FreeCAD GUI:'''

Point to distance value next to section
|| We can see that the depth of the section is measured to be 125 millimetres for LC 125.
|-
|| Only narration
|| We have measured the depth of the section using FreeCAD’s measuring tool.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have
* Handled the '''3D''' '''CAD model''' in '''Osdag'''
* Exported a '''CAD model''' from '''Osdag '''in a standard file format
* Imported and viewed the '''CAD model''' in '''FreeCAD'''

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following
* Explore the Change background option in the Graphics menu
* Save the '''3D''' '''CAD models '''in '''STEP''', '''STL''' and '''BREP '''file formats
* '''Import '''the model in any '''CAD '''manipulation software
* Perform some post-processing activity like measuring the size of the members, etc.

|-
|| '''Slide: About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum.
|-
|| '''Slide: FOSSEE Forum'''
|| For any general or technical questions on '''Osdag''', visit the '''FOSSEE forum''' and post your question.
|-
|| '''Slide: Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit the link below
[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: Acknowledgements'''
|| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education''', Government of India.
|-
|| '''Slide: Thank you'''
|| This is Anandajith TS,FOSSEE, IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C3/Handling-unsafe-designs-in-Osdag/English

2023-07-21T06:17:35Z

Anandajitht:

'''Title of the script:''' Handling unsafe designs in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

''Keywords:''' ''Video tutorial, Unsafe Design, Log Messages, Error, Warning, Info, Osdag'''

{| border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide: Title Slide'''
|| Welcome to the spoken tutorial on '''‘Handling unsafe designs in Osdag’.'''
|-
|| '''Slide: Learning Objectives'''
|| In this tutorial, we will learn how to
* Interpret the '''log messages '''in '''Osdag'''
* Read '''ERROR,''' '''WARNING '''and '''INFO '''messages, and
* Rectify an '''unsafe '''design using '''log messages'''

|-
|| '''Slide: System Requirements'''
|| To record this tutorial, I am using
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide: Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag '''installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Point to the '''home page''' of the '''Tension Member Design >>''' Select '''Bolted to End Gusset module'''
|| Let us switch to the '''home page''' of '''Tension Member Design.'''

Select''' Bolted to End Gusset module.'''
|-
|| Point toward the '''Input Dock''' fields
|| I have loaded the '''Logs underscore sample underscore design dot OSI '''file.
|-
|| Only narration
|| Please pause the tutorial and load the input file.
|-
|| Click on the '''Design '''button
|| Click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Point toward the '''CAD window'''
|| Note that the '''CAD window''' is inactive, and the '''Output Dock''' are inactive.
|-
|| Point toward the '''Output Dock'''
|| The Output Dock is not populated with the output values.
|-
|| Only narration
|| This is because the design is complete but '''unsafe'''.
|-
||
Point to the '''Output Dock.'''
|| Let us disable the '''Output Dock''' to maximise the '''log messages window'''.
|-
|| Click on the close '''Output Dock '''button
|| Click on the close button at the top right corner of the '''Output Dock'''.
|-
|| Point toward the '''Log messages'''
|| We see the colour-coded '''log messages''' pertaining to the design.
|-
|| Highlight the '''timestamp '''in the '''log messages'''
|| The '''log messages''' are marked with a '''timestamp '''for the reference of the users.
|-
|| Highlight '''ERROR '''message
|| The '''ERROR '''message is marked in red and indicates the status of the design.

In this case, the '''Design is unsafe.'''
|-
|| Only narration
|| Let us rectify the design using the '''log messages''' and arrive at a safe design solution.
|-
||
Point to the message in blue colour.
|| The '''WARNING '''messages''' '''are marked in Blue colour.
|-
|| Highlight the '''WARNING '''message
|| The '''WARNING '''message gives a '''warning '''pertaining to a specific design check.
|-
|| Highlight the '''WARNING '''message
|| The '''WARNING '''message reads, that the tension force exceeds the tension capacity. '''.
|-
||
Point to the message.
|| This means that the force exceeds the member capacity in tension.
|-
|| Point to the message.
|| The '''INFO '''messages''' '''are marked in Green colour.
|-
|| Highlight the first '''INFO '''message
|| The '''INFO '''message gives suggestions to rectify the unsafe design.
|-
|| Highlight the last '''INFO '''message
|| It also suggests where the '''design check''' or a '''trial design''' has ended.
|-
|| Highlight the first '''INFO '''message
|| The '''INFO '''message reads, '''‘Define member(s) with a higher cross sectional area.’'''
|-
||
Highlight '''80 x 80 x 8 '''in the message.
|| This means we have to define a section with an area greater than '''80 x 80 x 8.'''
|-
|| Only narration
|| Let us define a new section.
|-
|| Click on the '''Section Size drop-down menu'''
|| Click on the '''Section Size drop-down menu''' and select '''Customized'''.
|-
|| Double-click on '''80 x 80 x 8 '''in the '''Selected '''list
|| Double-click on '''80 x 80 x 8''' in the '''Selected '''list to deselect the section.
|-
|| Scroll down in the '''Available '''list and double click on '''90 x 90 x 8'''
|| Now, scroll down in the '''Available '''list.

Find '''90 x 90 x 8 '''and double-click on it to select the section.
|-
|| Click on the '''Submit '''button
|| Click on the '''Submit '''button below to confirm and exit.
|-
|| Click on the '''Design '''button
|| Then, click on the '''Design '''button below to perform the design.
|-
|| Point to the messages.
|| We see '''ERROR '''and '''WARNING '''messages again, as the design is still '''unsafe'''.
|-
|| Highlight the '''WARNING '''message
|| The '''WARNING '''message reads, that the tension force exceeds the tension capacity.
|-
||
Point to the messages.
|| Here, the section area is satisfied but the plate thickness is less.
|-
|| Only narration
|| Let us define a thicker '''gusset plate'''.
|-
|| Click on the '''Thickness drop-down menu'''
|| Click on the '''Thickness drop-down menu '''and select '''Customized'''.
|-
|| Double-click on '''12 '''in the '''Selected '''list
|| Double-click on '''12 '''in the '''Selected '''list to deselect the plate.
|-
|| From the '''Available '''list double-click on '''16'''
|| Now, from the '''Available '''list double-click on '''16''' to select the plate.
|-
|| Click on the '''Submit '''button
|| Click on the '''Submit '''button below to confirm and exit.
|-
|| Click on the '''Design '''button
|| Again, click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Highlight the fourth '''INFO '''message
|| The '''INFO '''message reads, '''‘Overall bolted tension member design is safe.’'''.
|-
|| Only narration
|| This means that the design is complete and successful.
|-
|| Highlight the third '''INFO '''message
|| If there is scope to optimize the design, '''Osdag '''will display additional '''INFO '''messages.
|-
|| Only narration
|| But, this does not mean that the design is unsafe.
|-
|| Only narration
|| Optimum design can be achieved by defining more inputs for the section, connectors, etc.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have
* Interpreted the '''log messages'''
* Read '''ERROR,''' '''WARNING '''and '''INFO '''messages
* Rectified an '''unsafe '''design using '''log messages'''

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following
* For the same design example
** Read the '''INFO '''messages, and
** Optimize the design solution by referring the suggestions in the '''INFO '''messages

|-
|| '''Slide: About Spoken Tutorial Project'''
|| The video at the following link summarizes the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum
|-
|| '''Slide: FOSSEE Forum'''
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: Acknowledgement'''
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: Thank you'''
|| This is Anandajith TS, IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Handling-unsafe-designs-in-Osdag/English

2023-07-21T06:17:16Z

Anandajitht: Created page with " ''Title of the script:''' Handling unsafe designs in Osdag '''Author''': Monika Soni (script), Anandajith TS (recording) ''Keywords:''' ''Video tutorial, Unsafe Design, Lo..."

''Title of the script:''' Handling unsafe designs in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

''Keywords:''' ''Video tutorial, Unsafe Design, Log Messages, Error, Warning, Info, Osdag'''

{| border=1
|-
|| '''Visual Cue'''
|| '''Narration'''
|-
|| '''Slide: Title Slide'''
|| Welcome to the spoken tutorial on '''‘Handling unsafe designs in Osdag’.'''
|-
|| '''Slide: Learning Objectives'''
|| In this tutorial, we will learn how to
* Interpret the '''log messages '''in '''Osdag'''
* Read '''ERROR,''' '''WARNING '''and '''INFO '''messages, and
* Rectify an '''unsafe '''design using '''log messages'''

|-
|| '''Slide: System Requirements'''
|| To record this tutorial, I am using
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide: Pre-requisites'''

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag '''installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website.
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Point to the '''home page''' of the '''Tension Member Design >>''' Select '''Bolted to End Gusset module'''
|| Let us switch to the '''home page''' of '''Tension Member Design.'''

Select''' Bolted to End Gusset module.'''
|-
|| Point toward the '''Input Dock''' fields
|| I have loaded the '''Logs underscore sample underscore design dot OSI '''file.
|-
|| Only narration
|| Please pause the tutorial and load the input file.
|-
|| Click on the '''Design '''button
|| Click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Point toward the '''CAD window'''
|| Note that the '''CAD window''' is inactive, and the '''Output Dock''' are inactive.
|-
|| Point toward the '''Output Dock'''
|| The Output Dock is not populated with the output values.
|-
|| Only narration
|| This is because the design is complete but '''unsafe'''.
|-
||
Point to the '''Output Dock.'''
|| Let us disable the '''Output Dock''' to maximise the '''log messages window'''.
|-
|| Click on the close '''Output Dock '''button
|| Click on the close button at the top right corner of the '''Output Dock'''.
|-
|| Point toward the '''Log messages'''
|| We see the colour-coded '''log messages''' pertaining to the design.
|-
|| Highlight the '''timestamp '''in the '''log messages'''
|| The '''log messages''' are marked with a '''timestamp '''for the reference of the users.
|-
|| Highlight '''ERROR '''message
|| The '''ERROR '''message is marked in red and indicates the status of the design.

In this case, the '''Design is unsafe.'''
|-
|| Only narration
|| Let us rectify the design using the '''log messages''' and arrive at a safe design solution.
|-
||
Point to the message in blue colour.
|| The '''WARNING '''messages''' '''are marked in Blue colour.
|-
|| Highlight the '''WARNING '''message
|| The '''WARNING '''message gives a '''warning '''pertaining to a specific design check.
|-
|| Highlight the '''WARNING '''message
|| The '''WARNING '''message reads, that the tension force exceeds the tension capacity. '''.
|-
||
Point to the message.
|| This means that the force exceeds the member capacity in tension.
|-
|| Point to the message.
|| The '''INFO '''messages''' '''are marked in Green colour.
|-
|| Highlight the first '''INFO '''message
|| The '''INFO '''message gives suggestions to rectify the unsafe design.
|-
|| Highlight the last '''INFO '''message
|| It also suggests where the '''design check''' or a '''trial design''' has ended.
|-
|| Highlight the first '''INFO '''message
|| The '''INFO '''message reads, '''‘Define member(s) with a higher cross sectional area.’'''
|-
||
Highlight '''80 x 80 x 8 '''in the message.
|| This means we have to define a section with an area greater than '''80 x 80 x 8.'''
|-
|| Only narration
|| Let us define a new section.
|-
|| Click on the '''Section Size drop-down menu'''
|| Click on the '''Section Size drop-down menu''' and select '''Customized'''.
|-
|| Double-click on '''80 x 80 x 8 '''in the '''Selected '''list
|| Double-click on '''80 x 80 x 8''' in the '''Selected '''list to deselect the section.
|-
|| Scroll down in the '''Available '''list and double click on '''90 x 90 x 8'''
|| Now, scroll down in the '''Available '''list.

Find '''90 x 90 x 8 '''and double-click on it to select the section.
|-
|| Click on the '''Submit '''button
|| Click on the '''Submit '''button below to confirm and exit.
|-
|| Click on the '''Design '''button
|| Then, click on the '''Design '''button below to perform the design.
|-
|| Point to the messages.
|| We see '''ERROR '''and '''WARNING '''messages again, as the design is still '''unsafe'''.
|-
|| Highlight the '''WARNING '''message
|| The '''WARNING '''message reads, that the tension force exceeds the tension capacity.
|-
||
Point to the messages.
|| Here, the section area is satisfied but the plate thickness is less.
|-
|| Only narration
|| Let us define a thicker '''gusset plate'''.
|-
|| Click on the '''Thickness drop-down menu'''
|| Click on the '''Thickness drop-down menu '''and select '''Customized'''.
|-
|| Double-click on '''12 '''in the '''Selected '''list
|| Double-click on '''12 '''in the '''Selected '''list to deselect the plate.
|-
|| From the '''Available '''list double-click on '''16'''
|| Now, from the '''Available '''list double-click on '''16''' to select the plate.
|-
|| Click on the '''Submit '''button
|| Click on the '''Submit '''button below to confirm and exit.
|-
|| Click on the '''Design '''button
|| Again, click on the '''Design '''button below to perform the design.
|-
|| Only narration
|| '''Osdag '''carries out the design.
|-
|| Highlight the fourth '''INFO '''message
|| The '''INFO '''message reads, '''‘Overall bolted tension member design is safe.’'''.
|-
|| Only narration
|| This means that the design is complete and successful.
|-
|| Highlight the third '''INFO '''message
|| If there is scope to optimize the design, '''Osdag '''will display additional '''INFO '''messages.
|-
|| Only narration
|| But, this does not mean that the design is unsafe.
|-
|| Only narration
|| Optimum design can be achieved by defining more inputs for the section, connectors, etc.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide: Summary'''

|| In this tutorial, we have
* Interpreted the '''log messages'''
* Read '''ERROR,''' '''WARNING '''and '''INFO '''messages
* Rectified an '''unsafe '''design using '''log messages'''

|-
|| '''Slide: Assignment'''
|| As an '''assignment''', do the following
* For the same design example
** Read the '''INFO '''messages, and
** Optimize the design solution by referring the suggestions in the '''INFO '''messages

|-
|| '''Slide: About Spoken Tutorial Project'''
|| The video at the following link summarizes the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:Answers for THIS Spoken Tutorial'''
|| Please post your timed queries in this forum
|-
|| '''Slide: FOSSEE Forum'''
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: Sample Design Examples'''

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: Acknowledgement'''
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: Thank you'''
|| This is Anandajith TS, IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Save-and-Import-input-values-in-Osdag/English

2023-07-20T23:59:43Z

Anandajitht:

'''Title of the script:''' Save and Import input values in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

'''Keywords:''' '''Osdag, Save inputs, OSI file, Import inputs, Video tutorial.'''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the spoken tutorial on '''‘Save and Import Input Values in Osdag’.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn how to,
* '''Save input '''values in '''Osdag'''
* Import '''OSI file '''and perform design

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using,
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Only narration
|| Let us perform a '''sample design''' and understand how to '''Save '''and '''Import '''inputs.
|-
|| '''Slide: '''Sample Design Example
||
* '''Design''' a '''Tension Member''' with a '''bolted end connection'''

* The member carries a '''factored axial force '''of '''600 kN'''

Perform a '''design check''' by adopting the given '''design '''specifications:
|-
|| '''Slide: '''Sample Design Example
||
* '''Section:'''
** '''Profile: ''' '''Star Angles'''
** '''Connection Location: Long Leg'''
** '''Section Size: 80 x 80 x 8'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 3200 mm'''

|-
|| '''Slide''': Sample design example
||
* '''End Connection:'''
** '''Connector: '''
*** '''Type: Bolted'''
*** '''Diameter: 16'''
*** '''Bolt Type: Friction Grip Bolt'''
*** '''Grade: 8.8'''
** '''Gusset Plate: '''
*** '''Thickness: 12 mm'''

|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Switch to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Cursor in the Input Dock.
|| Let us start filling the inputs for our''' sample design example'''.
|-
|| Cursor on different members.
|| We need to specify the member details first.
|-
|| Click on the '''Section Profile''' '''drop-down menu''' and''' '''select the '''Star Angles''' option.
|| Click on the '''Section Profile''' '''drop-down menu'''.

Select '''Star Angles '''from the list.
|-
|| Click on the '''Conn_Location '''drop-down menu and select '''Long Leg.'''
|| Click on the '''Conn_Location''' '''drop-down menu''' and select '''Long Leg'''.
|-
|| Click on the '''Section Size''' '''drop-down menu''' and select '''Customized.'''
|| Click on the '''Section Size''' drop-down menu and select '''Customized'''.
|-
|| Click on the '''<< '''button
|| Click on the fourth '''button''' to '''unselect '''all the '''sections '''at once.
|-
|| Point toward the '''Available '''list
|| Now, we have to select '''80 x 80 x 8 '''from the '''Available '''list of sections.
|-
|| Scroll down in the '''Available '''list and double click on '''80 x 80 x 8'''
|| Scroll down in the '''Available '''list and search for''' 80 x 80 x 8.'''

Double click on '''80 x 80 x 8 '''to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit the '''Customized '''window.
|-
|| Click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A.'''
|| Now, click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A.'''
|-
|| Type 3200 in the '''Length textbox'''
|| Specify the length of the member as '''3200 mm'''.
|-
|| Only narration
|| We have defined member details.

Let us now proceed with '''Load '''and '''Connector '''inputs.
|-
|| Type 600 in the '''Axial textbox'''
|| Enter, factored axial load as '''600 kN'''.
|-
|| Click on the '''Diameter drop-down menu''' and select '''Customized'''.
|| Click on the '''Diameter drop-down menu''' and select the '''Customized '''option.
|-
|| Click on the '''<< '''button
|| Click on the fourth '''button''' to '''unselect '''all the diameters at once.
|-
|| Double click on '''16'''
|| Now, from the '''Available '''list of diameters, double click on '''16''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Click the '''Type drop-down menu''' and select '''Friction Grip Bolt'''
|| From the '''Type drop-down menu''', select '''Friction Grip Bolt'''.
|-
|| Only narration
|| Let us now specify a corresponding '''bolt grade'''.
|-
|| Click on the '''Property Class drop-down menu '''and select '''Customized'''
|| Click on the '''Property Class drop-down menu''' and select '''Customized.'''
|-
|| Double click on '''8.8'''
|| From the '''Available '''list of grades, double click on '''8.8''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Click on the '''Thickness drop-down menu''' and select '''Customized'''
|| Now, click on the '''Thickness drop-down menu''' and select '''Customized.'''
|-
|| Double click on '''12'''
|| From the '''Available '''list of plates, double click on '''12''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Move the Cursor on all the Input values.
|| We have now entered the inputs correctly.
|-
|| Only narration
|| '''Osdag '''allows the user to save the inputs as an '''OSI '''file.

The '''OSI '''file can be loaded back into '''Osdag '''for faster retrieval of inputs.
|-
|| Only narration
|| Do not edit the '''OSI''' file manually, as it will get corrupted.
|-
|| Only narration
|| Let us save an '''OSI '''file for the given '''sample design example'''.
|-
|| Click on the''' File menu'''
|| Go to the '''Menu bar''' in the top left corner and click on the '''File menu'''.
|-
|| Select '''Save input'''
|| From the '''File menu''' list, select the '''Save input''' option.
|-
|| Point toward the '''Save Design window'''
|| The '''Save Design window''' will open.
|-
|| Point toward the '''Osdag_Workspace folder'''
|| I have already created a '''folder '''named '''Osdag_Workspace''' on my '''desktop'''.
|-
|| Only narration
|| Users can create a folder with a suitable name according to their convenience.
|-
|| Double click on the '''Osdag-workspace folder'''
|| I will double click on the '''Osdag hyphen workspace folder '''to open and select it.
|-
|| Type '''Input-sample-design '''in the '''File name textbox'''
|| Now, let us specify a file name in the '''File name textbox '''below.

I will edit the file name to '''Input hyphen sample hyphen design.'''
|-
|| Point towards '''Input-sample-design.OSI'''
|| Here we can see that the '''Input file''' has an''' OSI '''extension'''.'''
|-
|| Only narration
|| The acronym '''OSI '''stands for '''Osdag Input'''.
|-
|| Click on the '''Save button'''
|| Now, click on the '''Save button '''to save the '''OSI '''file and exit the '''Save Design window.'''
|-
|| Only narration
|| We can use this saved '''OSI '''file to retrieve the inputs and perform the design.

It can also be shared amongst peers for checking the design.
|-
|| Only narration
|| Let us now try to load the same '''OSI '''file and perform a '''design check'''.
|-
|| Click on the '''Reset '''button
|| Reset all the inputs to default by clicking the '''Reset '''button below the '''Input Dock'''.
|-
|| Point toward the '''Input Dock''' fields
|| We see the inputs are now set to their default values.
|-
|| Click on the''' File menu'''
|| Go to the '''Menu bar''' and click on the '''File menu'''.
|-
|| Select '''Load input'''
|| From the '''File menu''' list, select the '''Load input''' option.
|-
|| Point toward the '''Open Design window'''
|| The '''Open Design window''' will open.
|-
|| Point toward the '''Osdag-workspace folder'''
|| I have saved the '''OSI '''file in the '''Osdag-workspace''' folder.
|-
|| Double click on the '''Osdag-workspace folder '''and click on '''Input-sample-design.OSI '''file

|| Open the '''Osdag-workspace folder '''and select '''Input-sample-design.OSI '''file.
|-
|| Click on the '''Open button'''
|| Now, click on the '''Open button '''below to load the '''OSI '''file.
|-
|| Point toward the '''Input Dock''' fields
|| We see that the inputs are loaded automatically to the '''Input Dock'''.
|-
|| Cursor on all the input dock fields.
|| Users do not have to define the inputs one by one.
|-
|| Only narration
|| We are now ready to run the design.
|-
|| Click on the '''Design '''button
|| Click on the '''Design button''' below the '''Input Dock'''.
|-
|| Point toward the '''Log messages'''
|| We see the '''log messages '''in the '''log message window'''.

The status of the design is '''Unsafe'''.
|-
|| Only narration
|| This way '''Osdag '''has finished performing the '''design check '''successfully.
|-
|| Only narration
|| We will see how to rectify '''unsafe design''' in the next tutorial.
|-
|| Only narration
|| This brings us to the end of this tutorial.
|-
|| '''Slide''': Summary
|| In this tutorial, we have
* '''Saved input '''values
* Imported '''OSI file '''and performed design

|-
|| '''Slide: '''Assignment
|| As an '''assignment''', do the following
* Open '''Welded to End Gusset''' module of the '''Tension Member''' module
* Give your inputs
* Save the '''OSI '''file
* Check if the design is '''safe '''or '''unsafe'''

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C2/Performing-an-Optimum-Design-in-Osdag/English

2023-07-20T23:43:35Z

Anandajitht: Created page with "'''Title of the script:'' Performing an Optimum Design in Osdag '''Author''': Monika Soni (script), Anandajith TS (recording) '''Keywords:'' '''Osdag, optimum design, design..."

'''Title of the script:'' Performing an Optimum Design in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

'''Keywords:'' '''Osdag, optimum design, design check, member design, connection design, steel design optimisation, Tension member, database, GUI, video tutorial''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the Spoken Tutorial on '''‘Performing an Optimum Design in Osdag’.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn,
* Difference between '''optimum design '''and '''design check '''
* How to launch a '''design module'''

|-
|| '''Slide: '''Learning Objectives
|| * Step by step process to perform an '''optimum design '''
* How to review the results of an '''optimum design'''

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using
* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have* '''Osdag''' installed on your system, and
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.

|-
|| Only narration
|| In this '''tutorial, '''I will solve a '''sample design example''' to demonstrate Scenario 1.
|-
|| Show''' Osdag interface'''
|| I have already opened the '''Osdag software'''.
|-
|| Point to the Tension Member module on the left.
|| For this '''tutorial''', I will use the '''Tension Member''' '''module'''.
|-
|| Click on the '''Tension Member''' '''button'''
|| Click on the '''Tension Member''' '''button '''to select the '''module'''.
|-
|| Point towards the image of '''Bolted to End Gusset '''and '''Welded to End Gusset'''
|| We can see the available '''sub-modules. '''They are;
* '''Bolted to End Gusset''', and
* '''Welded to End Gusset.'''

|-
|| Cursor on Bolted Connection.
|| Let us try the '''bolted connection'''.
|-
|| Click on the '''Bolted to End Gusset module '''image

|| Click on the '''Bolted to End Gusset module '''image''' '''to select it.

|-
|| Click on the '''Start button'''
|| Then click the '''Start''' '''button '''below to load the '''module'''.
|-
|| Only narration
|| The '''home page''' of the '''design module''' will load dynamically.

The process might take a few seconds.
|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''

|| '''Home page''' of the '''Tension Member Design - Bolted to End Gusset module''' opens.

|-
|| Only narration
|| Let’s try to understand the '''design''' procedure by solving a '''sample''' '''design example.'''
|-
|| '''Slide: '''Sample Design Example
||
* '''Design''' a '''Tension Member''' with a '''bolted end connection'''
* The member carries a '''factored axial force '''of '''600 kN'''

|-
|| '''Slide: '''Sample Design Example
|| Perform an '''optimum design''' by adopting the following '''design '''specifications:

|-
|| '''Slide: '''Sample Design Example
||

* '''Section:'''
** '''Profile: Back to Back Channels'''
** '''Connection Location: Web'''
** '''Section Size: Most''' '''optimum'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 3200 mm'''

|-
|| '''Slide: '''Sample Design Example
||
* '''End Connection:'''
** '''Connector: '''
*** '''Type: Bolted'''
*** '''Bolt Type: Bearing Bolt'''
*** '''Diameter and Grade: Most''' '''optimum'''
** '''Gusset Plate: '''
*** '''Thickness: Most''' '''optimum'''

|-
|| Switch back to '''Osdag'''
|| Let us switch back to '''Osdag'''.
|-
|| Only narration
|| I will start filling the '''Input Dock''' for our '''sample design'''.
|-
|| Point toward the '''Input Dock'''
|| The '''Input Dock''' is on the left side of the '''GUI'''.

We will use it to define the inputs for our '''sample design.'''
|-
|| Click on the '''Section Profile drop-down menu'''
|| Click on the '''Section Profile''' '''drop-down''' '''menu'''.
|-
|| Point to all the options in the list.
|| The available standard '''section profiles '''get listed.
|-
|| Select '''Back to Back Channels '''
|| Select '''Back to Back Channels '''from the list.
|-
|| Point towards the representative image.

|| The selected '''Section Profile''' can be confirmed by looking at the representative image.
|-
|| Point towards the '''asterisk '''near '''Section Profile, Conn_Location, Length (mm)'''
|| The fields marked with an '''asterisk '''are mandatory user inputs.
|-
|| Point towards blank fields

|| Other fields can simply be left without giving any input.

In this case, '''Osdag '''will consider '''default '''inputs for performing the '''design'''.
|-
|| Click on '''Conn_Location drop-down menu'''
|| Click on the '''Conn_Location''' '''drop-down menu'''.
|-
|| Select '''Web'''
|| Select '''Web '''from the list.
|-
|| Click on the '''Section Size drop-down menu'''
|| For the '''Section Size''', we can either choose to perform the '''design '''with
* '''All''' or
* The '''Customized''' option.

|-
|| Select the All option and hold the mouse to display its selection.
|| Selecting '''All''' will perform the '''design '''with all the '''sections '''in the '''database'''.

The '''All''' option is used to perform an '''optimum design'''.
|-
|| Only narration
|| We can also perform a '''design check''' by choosing specific '''sections'''.

Desired sections can be selected from the '''Customized '''option.
|-
|| Select the '''Customized''' option.

Point to Customized window.

Point to '''Available''' and '''Selected '''sections.
|| Let us select the '''Customized '''option.

Customized window opens with '''Available''' and '''Selected '''sections.

|-
|| Point toward the '''Selected '''sections in the '''Customized window'''.
|| '''Selected '''section displays the list of standard section sizes from the '''database.'''

|-
|| Click on the cross field at the right corner
|| Now, close the '''Customized window'''.
|-
|| Click on the '''Section Size drop-down menu'''
|| We will go back to the '''Section Size drop-down menu.'''
|-
|| Select '''All '''option.
|| And, select '''All''' for our '''design example'''.
|-
|| Point to '''Material'''.
|| Let us now specify the '''Material grade'''.
|-
|| Click on the '''Material drop-down menu.'''
|| Click on the '''Material drop-down menu'''.

|-
|| '''Scroll '''through the list
|| The list of standard '''material grades '''will open.
|-
|| Point towards the '''Custom '''option.
|| '''Custom material properties''' can be defined and saved by using the '''Custom '''option.
|-
|| Scroll up and select '''E 250 (Fe 410 W)A'''
|| I will select '''E 250 (Fe 410 W)A''' option.
|-
|| Type 3200 in the Length text box.
|| Type the '''Length '''of the '''member '''as 3200 '''mm'''.
|-
|| Point to '''Factored Loads'''.
|| Let us now define the '''Factored Loads'''.
|-
|| Click in the '''Axial''' '''load textbox'''
|| The''' load''' values are defined using a '''textbox'''.
|-
|| Type '''600''' in the text box.
|| Enter the value of '''Axial load '''as 600 '''kN'''.
|-
|| Only narration
|| Let us now give input for the '''connector'''.
|-
|| Click on the '''Bolt Diameter drop-down menu '''

And click again on it to close the list
|| For the '''Bolt Diameter,''' we can choose between
* '''All''' or
* '''Customized'''.

|-
|| Click on the '''Property Class drop-down menu '''and click again on it to close the list
|| Similarly, for the '''Property Class,''' we can choose between
* '''All''' or
* '''Customized'''.

|-
|| Select '''All '''option and hold the mouse to show its selection.
|| Selecting '''All''' will give an '''optimum bolt design''' with respect to
* '''Diameter'''
* '''Grade''' and
* Number of '''bolts'''.

|-
|| Select the '''Customized '''option and hold the mouse to show its selection.
|| We can also check the '''design '''with a specific '''Bolt diameter''' and '''grade'''.

Desired '''connectors '''can be specified by using the '''Customized '''option.
|-
|| Click on the''' Diameter drop-down menu'''
|| For an optimum '''bolt design''' we should select the '''All '''option.
|-
|| Select '''All '''option.
|| I will select the '''All '''option.
|-
|| Click on the''' Type drop-down menu.'''
|| The '''Type drop-down menu''' lists the standard types of bolts.
|-
|| Select '''Bearing Bolt'''
|| Select''' Bearing Bolt''' from the''' menu.'''
|-
|| Click on the '''Property Class drop-down menu.'''
|| Similarly, for an '''optimum property class,''' we should select the '''All '''option.
|-
|| Select '''All '''option.

|| Select the '''All '''option.
|-
|| Click on the '''Thickness drop-down menu'''
|| The '''Thickness drop-down menu''' lists the plates of standard thickness.
|-
|| Select '''All '''option under Plate.

|| We will again select '''All '''for an '''optimum plate '''design.
|-
|| Move the cursor on all the inputs from top to bottom.
|| We have entered all the inputs in the '''Input Dock'''.

Once all the inputs are entered correctly we are ready to perform the '''design'''.
|-
|| Click on the '''Design''' '''button'''
|| Click on the '''Design button '''at the bottom to start the '''design'''.
|-
|| Point to the progress bar at the top.

|| The '''progress bar''' will show the '''status '''of the '''design'''.

The '''design process''' takes some time depending on the input values.

Typically, '''optimum design''' takes more time,

As It runs many iterations before selecting an '''optimal solution'''.
|-
|| Point toward the '''log messages'''
|| The '''log message''' indicates that the '''design '''is '''safe'''.

This means that the '''design '''is complete.
|-
|| Point towards the '''Output Dock''' and the '''CAD window'''
|| The '''Output Dock''' and '''CAD window''' become active only if the '''design '''is successful.
|-
|| Point towards the '''CAD window'''
|| The''' CAD window''' will display the '''3D CAD model''' of the designed '''component'''.
|-
|| Point towards the '''Output Dock'''

|| The '''Output Dock''' is populated with the '''design''' results as our '''design '''is '''safe'''.

|-
|| Only narration
|| Let us now interpret the design results.
|-
|| Move the cursor towards the '''Output Dock'''
|| Go to the '''Output Dock'''.
|-
|| Point towards '''Section Details'''
|| The results of the '''optimum section''' are shown in '''Section Details'''.
|-
|| Point towards '''Designation'''
|| For our '''sample design''', the '''optimum section''' is '''LC 125.'''
|-
|| Point towards '''capacity details'''
|| The various '''capacity details''' and the '''efficiency '''of this '''section '''are listed.
|-
|| Point towards the '''Shear Pattern''' button.
|| The '''Shear Pattern '''shows the '''Member Block Shear '''failure '''Pattern'''.
|-
|| Click on the '''Shear Pattern '''button.
|| Click on the '''Shear Pattern '''button.
|-
||Cursor in the window.

Point to the pattern.
|| The '''Shear Pattern window '''opens.

We see a typical and representative image of the '''Member Block Shear Pattern'''.
|-
|| Click on the cross field at the right corner of the '''Shear Pattern window'''
|| Close the '''Shear Pattern window.'''
|-
|| Point towards '''End Connection'''
|| The '''member design''' also includes the '''design '''of''' '''the '''End Connection'''.
|-
|| Point towards '''Bolt Details''' and '''Gusset Plate Details'''
|| It displays '''Bolt Details '''and '''Gusset Plate Details''' respectively.
|-
|| Point towards the '''Spacing Details''' button.
|| The '''Spacing Details button '''shows the '''Spacing Details'''.
|-
|| Click on the '''Spacing Details button.'''
|| Click on the '''Spacing Details button.'''
|-
|| Cursor in the window.

Point to the pattern.
|| The '''Spacing Details window '''will open.

We see a typical and representative image of '''Spacing Details'''.
|-
|| Click on the cross field at the right corner of the '''Spacing Details window'''
|| Close the '''Spacing Details window.'''
|-
|| Scroll down in the '''Output Dock'''
|| '''Scroll '''down for more results.
|-
|| Point towards the '''Intermittent Connection field'''
|| Details pertaining to the '''Intermittent Connection''' are also shown.
|-
|| Point toward the '''Create Design Report button '''below
|| The outputs for a '''design '''can be saved using the '''Create Design Report''' '''button'''.
|-
|| Only narration
|| All the '''design checks''' are echoed in detail in the '''design report'''.
|-
|| Only narration
|| We will learn how to create a '''design report '''in another tutorial.
|-
|| Only narration
|| This brings us to the end of the tutorial.

Let us summarize.
|-
|| '''Slide: '''Summary
|| In this tutorial, we have
* Launched a '''design module'''
* Learnt step by step process to perform an '''optimum design '''
* Reviewed the results of an '''optimum design'''

|-
|| '''Slide: '''Assignment
|| As an assignment, please do the following
* Design a '''Tension Member''' with a '''welded '''end connection
* The member carries a '''factored axial force '''of 235 '''kN'''

|-
|| '''Slide: '''Assignment
|| Perform an '''optimum design''' by adopting the following design specifications
|-
|| '''Slide: '''Assignment
||
* '''Section:'''
** '''Profile: Angles'''
** '''Connection Location: Longer leg'''
** '''Section Size: Most optimum'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 2560 mm'''
* '''Gusset Plate: Most optimum'''

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

https://osdag.fossee.in/resources/sample-design

||
* The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Save-and-Import-input-values-in-Osdag/English

2023-07-20T22:54:38Z

Anandajitht:

'''Title of the script:''' Save and Import input values in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

'''Keywords:''' '''Osdag, Save inputs, OSI file, Import inputs, Video tutorial.'''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the spoken tutorial on '''‘Save and Import Input Values in Osdag’.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn how to,* '''Save input '''values in '''Osdag'''
* Import '''OSI file '''and perform design

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using,* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Only narration
|| Let us perform a '''sample design''' and understand how to '''Save '''and '''Import '''inputs.
|-
|| '''Slide: '''Sample Design Example
|| * '''Design''' a '''Tension Member''' with a '''bolted end connection'''

* The member carries a '''factored axial force '''of '''600 kN'''

Perform a '''design check''' by adopting the given '''design '''specifications:
|-
|| '''Slide: '''Sample Design Example
|| '''Section:'''*
** '''Profile: ''' '''Star Angles'''
** '''Connection Location: Long Leg'''
** '''Section Size: 80 x 80 x 8'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 3200 mm'''

|-
|| '''Slide''': Sample design example
|| '''End Connection:'''* '''Connector: '''
** '''Type: Bolted'''
** '''Diameter: 16'''
** '''Bolt Type: Friction Grip Bolt'''
** '''Grade: 8.8'''
* '''Gusset Plate: '''
** '''Thickness: 12 mm'''

|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Switch to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Cursor in the Input Dock.
|| Let us start filling the inputs for our''' sample design example'''.
|-
|| Cursor on different members.
|| We need to specify the member details first.
|-
|| Click on the '''Section Profile''' '''drop-down menu''' and''' '''select the '''Star Angles''' option.
|| Click on the '''Section Profile''' '''drop-down menu'''.

Select '''Star Angles '''from the list.
|-
|| Click on the '''Conn_Location '''drop-down menu and select '''Long Leg.'''
|| Click on the '''Conn_Location''' '''drop-down menu''' and select '''Long Leg'''.
|-
|| Click on the '''Section Size''' '''drop-down menu''' and select '''Customized.'''
|| Click on the '''Section Size''' drop-down menu and select '''Customized'''.
|-
|| Click on the '''<< '''button
|| Click on the fourth '''button''' to '''unselect '''all the '''sections '''at once.
|-
|| Point toward the '''Available '''list
|| Now, we have to select '''80 x 80 x 8 '''from the '''Available '''list of sections.
|-
|| Scroll down in the '''Available '''list and double click on '''80 x 80 x 8'''
|| Scroll down in the '''Available '''list and search for''' 80 x 80 x 8.'''

Double click on '''80 x 80 x 8 '''to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit the '''Customized '''window.
|-
|| Click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A.'''
|| Now, click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A.'''
|-
|| Type 3200 in the '''Length textbox'''
|| Specify the length of the member as '''3200 mm'''.
|-
|| Only narration
|| We have defined member details.

Let us now proceed with '''Load '''and '''Connector '''inputs.
|-
|| Type 600 in the '''Axial textbox'''
|| Enter, factored axial load as '''600 kN'''.
|-
|| Click on the '''Diameter drop-down menu''' and select '''Customized'''.
|| Click on the '''Diameter drop-down menu''' and select the '''Customized '''option.
|-
|| Click on the '''<< '''button
|| Click on the fourth '''button''' to '''unselect '''all the diameters at once.
|-
|| Double click on '''16'''
|| Now, from the '''Available '''list of diameters, double click on '''16''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Click the '''Type drop-down menu''' and select '''Friction Grip Bolt'''
|| From the '''Type drop-down menu''', select '''Friction Grip Bolt'''.
|-
|| Only narration
|| Let us now specify a corresponding '''bolt grade'''.
|-
|| Click on the '''Property Class drop-down menu '''and select '''Customized'''
|| Click on the '''Property Class drop-down menu''' and select '''Customized.'''
|-
|| Double click on '''8.8'''
|| From the '''Available '''list of grades, double click on '''8.8''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Click on the '''Thickness drop-down menu''' and select '''Customized'''
|| Now, click on the '''Thickness drop-down menu''' and select '''Customized.'''
|-
|| Double click on '''12'''
|| From the '''Available '''list of plates, double click on '''12''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Move the Cursor on all the Input values.
|| We have now entered the inputs correctly.
|-
|| Only narration
|| '''Osdag '''allows the user to save the inputs as an '''OSI '''file.

The '''OSI '''file can be loaded back into '''Osdag '''for faster retrieval of inputs.
|-
|| Only narration
|| Do not edit the '''OSI''' file manually, as it will get corrupted.
|-
|| Only narration
|| Let us save an '''OSI '''file for the given '''sample design example'''.
|-
|| Click on the''' File menu'''
|| Go to the '''Menu bar''' in the top left corner and click on the '''File menu'''.
|-
|| Select '''Save input'''
|| From the '''File menu''' list, select the '''Save input''' option.
|-
|| Point toward the '''Save Design window'''
|| The '''Save Design window''' will open.
|-
|| Point toward the '''Osdag_Workspace folder'''
|| I have already created a '''folder '''named '''Osdag_Workspace''' on my '''desktop'''.
|-
|| Only narration
|| Users can create a folder with a suitable name according to their convenience.
|-
|| Double click on the '''Osdag-workspace folder'''
|| I will double click on the '''Osdag hyphen workspace folder '''to open and select it.
|-
|| Type '''Input-sample-design '''in the '''File name textbox'''
|| Now, let us specify a file name in the '''File name textbox '''below.

I will edit the file name to '''Input hyphen sample hyphen design.'''
|-
|| Point towards '''Input-sample-design.OSI'''
|| Here we can see that the '''Input file''' has an''' OSI '''extension'''.'''
|-
|| Only narration
|| The acronym '''OSI '''stands for '''Osdag Input'''.
|-
|| Click on the '''Save button'''
|| Now, click on the '''Save button '''to save the '''OSI '''file and exit the '''Save Design window.'''
|-
|| Only narration
|| We can use this saved '''OSI '''file to retrieve the inputs and perform the design.

It can also be shared amongst peers for checking the design.
|-
|| Only narration
|| Let us now try to load the same '''OSI '''file and perform a '''design check'''.
|-
|| Click on the '''Reset '''button
|| Reset all the inputs to default by clicking the '''Reset '''button below the '''Input Dock'''.
|-
|| Point toward the '''Input Dock''' fields
|| We see the inputs are now set to their default values.
|-
|| Click on the''' File menu'''
|| Go to the '''Menu bar''' and click on the '''File menu'''.
|-
|| Select '''Load input'''
|| From the '''File menu''' list, select the '''Load input''' option.
|-
|| Point toward the '''Open Design window'''
|| The '''Open Design window''' will open.
|-
|| Point toward the '''Osdag-workspace folder'''
|| I have saved the '''OSI '''file in the '''Osdag-workspace''' folder.
|-
|| Double click on the '''Osdag-workspace folder '''and click on '''Input-sample-design.OSI '''file

|| Open the '''Osdag-workspace folder '''and select '''Input-sample-design.OSI '''file.
|-
|| Click on the '''Open button'''
|| Now, click on the '''Open button '''below to load the '''OSI '''file.
|-
|| Point toward the '''Input Dock''' fields
|| We see that the inputs are loaded automatically to the '''Input Dock'''.
|-
|| Cursor on all the input dock fields.
|| Users do not have to define the inputs one by one.
|-
|| Only narration
|| We are now ready to run the design.
|-
|| Click on the '''Design '''button
|| Click on the '''Design button''' below the '''Input Dock'''.
|-
|| Point toward the '''Log messages'''
|| We see the '''log messages '''in the '''log message window'''.

The status of the design is '''Unsafe'''.
|-
|| Only narration
|| This way '''Osdag '''has finished performing the '''design check '''successfully.
|-
|| Only narration
|| We will see how to rectify '''unsafe design''' in the next tutorial.
|-
|| Only narration
|| This brings us to the end of this tutorial.
|-
|| '''Slide''': Summary
|| In this tutorial, we have* '''Saved input '''values
* Imported '''OSI file '''and performed design

|-
|| '''Slide: '''Assignment
|| As an '''assignment''', do the following* Open '''Welded to End Gusset''' module of the '''Tension Member''' module
* Give your inputs
* Save the '''OSI '''file
* Check if the design is '''safe '''or '''unsafe'''

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
|| * The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C3/Save-and-Import-input-values-in-Osdag/English

2023-07-20T20:36:58Z

Anandajitht: Created page with " '''Title of the script:''' Save and Import input values in Osdag '''Author''': >Monika Soni (script), Anandajith TS (recording) '''Keywords:''' '''Osdag, Save inputs, OSI..."

'''Title of the script:''' Save and Import input values in Osdag

'''Author''': >Monika Soni (script), Anandajith TS (recording)

'''Keywords:''' '''Osdag, Save inputs, OSI file, Import inputs, Video tutorial.'''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the spoken tutorial on '''‘Save and Import Input Values in Osdag’.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn how to,* '''Save input '''values in '''Osdag'''
* Import '''OSI file '''and perform design

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using,* '''Windows 11 OS''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

The prerequisite''' '''tutorials are available on this website
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is the same.

Annotations are added to the tutorial if there are any differences.
|-
|| Only narration
|| Let us perform a '''sample design''' and understand how to '''Save '''and '''Import '''inputs.
|-
|| '''Slide: '''Sample Design Example
|| * '''Design''' a '''Tension Member''' with a '''bolted end connection'''

* The member carries a '''factored axial force '''of '''600 kN'''

Perform a '''design check''' by adopting the given '''design '''specifications:
|-
|| '''Slide: '''Sample Design Example
|| '''Section:'''*
** '''Profile: ''' '''Star Angles'''
** '''Connection Location: Long Leg'''
** '''Section Size: 80 x 80 x 8'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 3200 mm'''

|-
|| '''Slide''': Sample design example
|| '''End Connection:'''* '''Connector: '''
** '''Type: Bolted'''
** '''Diameter: 16'''
** '''Bolt Type: Friction Grip Bolt'''
** '''Grade: 8.8'''
* '''Gusset Plate: '''
** '''Thickness: 12 mm'''

|-
|| Point to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module'''
|| Switch to the '''home page''' of the '''Tension Member Design - Bolted to End Gusset module.'''
|-
|| Cursor in the Input Dock.
|| Let us start filling the inputs for our''' sample design example'''.
|-
|| Cursor on different members.
|| We need to specify the member details first.
|-
|| Click on the '''Section Profile''' '''drop-down menu''' and''' '''select the '''Star Angles''' option.
|| Click on the '''Section Profile''' '''drop-down menu'''.

Select '''Star Angles '''from the list.
|-
|| Click on the '''Conn_Location '''drop-down menu and select '''Long Leg.'''
|| Click on the '''Conn_Location''' '''drop-down menu''' and select '''Long Leg'''.
|-
|| Click on the '''Section Size''' '''drop-down menu''' and select '''Customized.'''
|| Click on the '''Section Size''' drop-down menu and select '''Customized'''.
|-
|| Click on the '''<< '''button
|| Click on the fourth '''button''' to '''unselect '''all the '''sections '''at once.
|-
|| Point toward the '''Available '''list
|| Now, we have to select '''80 x 80 x 8 '''from the '''Available '''list of sections.
|-
|| Scroll down in the '''Available '''list and double click on '''80 x 80 x 8'''
|| Scroll down in the '''Available '''list and search for''' 80 x 80 x 8.'''

Double click on '''80 x 80 x 8 '''to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit the '''Customized '''window.
|-
|| Click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A.'''
|| Now, click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A.'''
|-
|| Type 3200 in the '''Length textbox'''
|| Specify the length of the member as '''3200 mm'''.
|-
|| Only narration
|| We have defined member details.

Let us now proceed with '''Load '''and '''Connector '''inputs.
|-
|| Type 600 in the '''Axial textbox'''
|| Enter, factored axial load as '''600 kN'''.
|-
|| Click on the '''Diameter drop-down menu''' and select '''Customized'''.
|| Click on the '''Diameter drop-down menu''' and select the '''Customized '''option.
|-
|| Click on the '''<< '''button
|| Click on the fourth '''button''' to '''unselect '''all the diameters at once.
|-
|| Double click on '''16'''
|| Now, from the '''Available '''list of diameters, double click on '''16''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Click the '''Type drop-down menu''' and select '''Friction Grip Bolt'''
|| From the '''Type drop-down menu''', select '''Friction Grip Bolt'''.
|-
|| Only narration
|| Let us now specify a corresponding '''bolt grade'''.
|-
|| Click on the '''Property Class drop-down menu '''and select '''Customized'''
|| Click on the '''Property Class drop-down menu''' and select '''Customized.'''
|-
|| Double click on '''8.8'''
|| From the '''Available '''list of grades, double click on '''8.8''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Click on the '''Thickness drop-down menu''' and select '''Customized'''
|| Now, click on the '''Thickness drop-down menu''' and select '''Customized.'''
|-
|| Double click on '''12'''
|| From the '''Available '''list of plates, double click on '''12''' to select it.
|-
|| Click '''Submit'''
|| Click on the '''Submit button '''below to save and exit.
|-
|| Move the Cursor on all the Input values.
|| We have now entered the inputs correctly.
|-
|| Only narration
|| '''Osdag '''allows the user to save the inputs as an '''OSI '''file.

The '''OSI '''file can be loaded back into '''Osdag '''for faster retrieval of inputs.
|-
|| Only narration
|| Do not edit the '''OSI''' file manually, as it will get corrupted.
|-
|| Only narration
|| Let us save an '''OSI '''file for the given '''sample design example'''.
|-
|| Click on the''' File menu'''
|| Go to the '''Menu bar''' in the top left corner and click on the '''File menu'''.
|-
|| Select '''Save input'''
|| From the '''File menu''' list, select the '''Save input''' option.
|-
|| Point toward the '''Save Design window'''
|| The '''Save Design window''' will open.
|-
|| Point toward the '''Osdag_Workspace folder'''
|| I have already created a '''folder '''named '''Osdag_Workspace''' on my '''desktop'''.
|-
|| Only narration
|| Users can create a folder with a suitable name according to their convenience.
|-
|| Double click on the '''Osdag-workspace folder'''
|| I will double click on the '''Osdag hyphen workspace folder '''to open and select it.
|-
|| Type '''Input-sample-design '''in the '''File name textbox'''
|| Now, let us specify a file name in the '''File name textbox '''below.

I will edit the file name to '''Input hyphen sample hyphen design.'''
|-
|| Point towards '''Input-sample-design.OSI'''
|| Here we can see that the '''Input file''' has an''' OSI '''extension'''.'''
|-
|| Only narration
|| The acronym '''OSI '''stands for '''Osdag Input'''.
|-
|| Click on the '''Save button'''
|| Now, click on the '''Save button '''to save the '''OSI '''file and exit the '''Save Design window.'''
|-
|| Only narration
|| We can use this saved '''OSI '''file to retrieve the inputs and perform the design.

It can also be shared amongst peers for checking the design.
|-
|| Only narration
|| Let us now try to load the same '''OSI '''file and perform a '''design check'''.
|-
|| Click on the '''Reset '''button
|| Reset all the inputs to default by clicking the '''Reset '''button below the '''Input Dock'''.
|-
|| Point toward the '''Input Dock''' fields
|| We see the inputs are now set to their default values.
|-
|| Click on the''' File menu'''
|| Go to the '''Menu bar''' and click on the '''File menu'''.
|-
|| Select '''Load input'''
|| From the '''File menu''' list, select the '''Load input''' option.
|-
|| Point toward the '''Open Design window'''
|| The '''Open Design window''' will open.
|-
|| Point toward the '''Osdag-workspace folder'''
|| I have saved the '''OSI '''file in the '''Osdag-workspace''' folder.
|-
|| Double click on the '''Osdag-workspace folder '''and click on '''Input-sample-design.OSI '''file

|| Open the '''Osdag-workspace folder '''and select '''Input-sample-design.OSI '''file.
|-
|| Click on the '''Open button'''
|| Now, click on the '''Open button '''below to load the '''OSI '''file.
|-
|| Point toward the '''Input Dock''' fields
|| We see that the inputs are loaded automatically to the '''Input Dock'''.
|-
|| Cursor on all the input dock fields.
|| Users do not have to define the inputs one by one.
|-
|| Only narration
|| We are now ready to run the design.
|-
|| Click on the '''Design '''button
|| Click on the '''Design button''' below the '''Input Dock'''.
|-
|| Point toward the '''Log messages'''
|| We see the '''log messages '''in the '''log message window'''.

The status of the design is '''Unsafe'''.
|-
|| Only narration
|| This way '''Osdag '''has finished performing the '''design check '''successfully.
|-
|| Only narration
|| We will see how to rectify '''unsafe design''' in the next tutorial.
|-
|| Only narration
|| This brings us to the end of this tutorial.
|-
|| '''Slide''': Summary
|| In this tutorial, we have* '''Saved input '''values
* Imported '''OSI file '''and performed design

|-
|| '''Slide: '''Assignment
|| As an '''assignment''', do the following* Open '''Welded to End Gusset''' module of the '''Tension Member''' module
* Give your inputs
* Save the '''OSI '''file
* Check if the design is '''safe '''or '''unsafe'''

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
|| * The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C2/Performing-a-design-check-in-Osdag/English

2023-07-06T10:06:58Z

Anandajitht:

'''Title of the script:''' Performing a design check in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

'''Keywords:''' '''Video tutorial, Design check, Database, Design Process, GUI, Osdag'''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the spoken tutorial on '''Performing a design check in Osdag.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn how to,
* Perform a '''design check'''
* Interpret the '''log messages'''
* Rectify '''unsafe''' designs using '''log messages'''
* Arrive at a '''safe '''design using '''log messages'''

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using:
* '''Windows 11 Operating System''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,
* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

If not please access the prerequisite''' '''tutorials available on this website.
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and '''Windows '''is the same.

|-
|| Only narration
|| In this tutorial, We will solve a '''sample design example''' to demonstrate Scenario 2.
|-
|| '''Slide: Sample Design Example'''
||
* Design a '''Tension Member''' with a '''bolted end connection'''

* The member carries a '''factored axial force '''of '''500 kN'''

* Let’s perform a '''design check''' by adopting the given '''design '''specifications:

* '''Section:'''
** '''Profile: Back to Back Angles'''
** '''Connection Location: Long Leg'''
** '''Section Size: 120x120x12'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 3200 mm'''

|-
|| '''Slide: '''Sample Design Example
||
*'''End Connection:'''
** '''Connector: '''
*** '''Type: Bolted'''
*** '''Diameter: 16, 20'''
*** '''Bolt Type: Bearing Bolt'''
*** '''Grade: 4.8, 5.8, 6.8'''
** '''Gusset Plate: '''
*** '''Thickness: 16 mm'''

|-
|| Only narration
|| Let us switch to '''Osdag'''.
|-
|| Point to Input Dock
|| Now let’s start filling the '''Input Dock''' for our '''sample design'''.
|-
|| Click on the '''Section Profile drop-down menu'''
|| Click on the '''Section Profile''' '''drop-down''' '''menu'''.
|-
|| Select '''Back to Back Angles'''
|| Let’s select '''Back to Back Angles '''from the list of profiles.
|-
|| Click on the '''Conn_Location drop-down menu'''
|| Now, click the '''Conn_Location drop-down menu.'''
|-
|| Select '''Long Leg'''
|| Select '''Long Leg '''from the list.
|-
|| Cursor near Section Size.
|| Now, let us define the '''custom section''' size.
|-
|| Only narration
|| In this case we have to define a 120 x 120 x 12''' Angle section.'''
|-
|| Click on the '''Section Size drop- down''' '''menu '''and select '''Customized.'''
|| Click on the '''Section Size drop-down''' '''menu''', and

Select '''Customized'''.
|-
|| Point toward the '''Customized window'''.
|| The '''Customized window''' opens.
|-
|| Point toward the list of '''Selected sections '''in the '''Customized window'''.
|| Currently, all the '''sections '''are selected by default.
|-
|| Point to the four types of buttons in the window.
|| There are four types of '''buttons '''available for selection.
|-
|| Point toward the '''>> button'''
|| The first '''button '''selects all the sections at once.

It sends all the sections to the '''Selected '''list.
|-
|| Point toward the '''> button'''
|| The second '''button '''selects a single section and sends it to the '''Selected '''list.
|-
|| Point toward the '''< button'''
|| The third '''button '''deselects a single section from the '''Selected '''list.

It sends the section back to the '''Available '''list.
|-
|| Point toward the '''<< button'''
|| And, the fourth '''button '''deselects all the sections at once.

It sends all the sections back to the '''Available '''list.
|-
|| Click on the '''<< button'''
|| Click on the fourth '''button''' to '''unselect '''all the '''sections '''at once.
|-
|| Point toward the list of '''Available sections '''in the '''Customized window'''.
|| We can select the desired section from the list of '''Available sections. '''
|-
|| '''Scroll '''down multiple times in the list of '''Available sections '''in the '''Customized window'''.
|| '''Scroll '''down the list of '''Available sections '''to locate '''120x120x12.'''
|-
|| Point toward '''120x120x12'''
|| We have located the desired '''section'''.
|-
|| Point to the section.
|| There are two ways to select a '''section:'''

We can either '''double-click''' on a particular '''section '''to select it right away.
|-
|| '''Click '''on '''120x120x12'''
|| Another way is to '''click '''on the desired '''section '''to choose it.
|-
|| Click on the '''> button'''
|| Then '''click '''the second '''button''' to add it to the list of '''Selected sections'''.
|-
|| Point toward '''120x120x12 '''in the '''Selected sections '''list
|| We can now see the '''section '''listed under the '''Selected sections '''on the right.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Only narration
|| Let us now specify the '''Material Grade.'''
|-
|| Click on the '''Material drop-down menu '''and''' '''Select '''E 250 (Fe 410 W)A'''
|| Click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A'''.
|-
|| Type 3200
|| Enter the '''Length '''of the '''member '''as 3200 '''mm'''.
|-
|| '''Factored Loads'''.
|| Let us now define the '''Factored Loads'''.
|-
|| Type 500
|| Enter the value of '''Axial load '''as 500 '''kN'''.
|-
|| Only narration
|| Let us now give input for the '''connector'''.
|-
|| '''Click '''on the '''Diameter drop-down menu '''and

Select '''Customized.'''
|| '''Click '''on the '''Diameter drop-down menu''', and

Select '''Customized.'''
|-
|| Point to the '''Selected list.'''

Move using the '''<< double arrow '''button.
|| Here we see all the diameters in the '''Selected list'''.

Users can move the list to the '''Available''' section.
|-
|| Point toward the '''Available '''list
|| The standard '''Available '''bolt diameters are listed on the left.
|-
|| Only narration
|| Next, we will select the desired diameters from this list.
|-
|| Press '''Ctrl '''and click on 16 and 20
|| Press the '''Ctrl key '''and click on 16 and 20 to select multiple diameters from the list.
|-
|| Click on the '''> button'''
|| Then '''click '''on the second '''button''' to add them to the list of '''Selected diameters'''.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Click on the''' Type drop-down menu '''and select '''Bearing Bolt '''
|| For the '''bolt Type, '''select''' Bearing Bolt.'''

|-
|| Click on the '''Property Class drop-down menu'''
|| '''Click '''on the '''Property Class drop-down menu''', and

Select '''Customized.'''
|-
|| Point toward the '''Selected '''list
|| The standard available bolt '''grades '''are listed on the right.
|-
|| Only narration
|| All the grades are selected by default in the '''Customized '''option.

Let us now deselect the unwanted '''grades '''from this list.
|-
|| Press '''Ctrl '''and click on 3.6, 4.6, 5.6, 8.8, 9.8, 10.9 and 12.9
|| Press the '''Ctrl key '''and click on 3.6, 4.6, 5.6, 8.8, 9.8, 10.9 and 12.9.
|-
|| Click on the '''< button'''
|| Now, '''click '''on the third '''button''' to send them back to the '''Available '''list.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Only narration
|| Let us now define the plate thickness.
|-
|| Click on the '''Thickness drop-down menu'''
|| '''Click '''on the '''Thickness drop-down menu''', and

Select '''Customized.'''
|-
|| Point toward the '''Selected '''list
|| The standard available plate '''thicknesses '''are listed on the right.
|-
|| Only narration
|| Let us now de-select the unwanted '''thicknesses '''from this list.
|-
|| Click on the '''<< button'''
|| Click on the fourth button to de-select all the sections at once.
|-
|| '''Double-click''' on 16
|| Now''', Double-click''' on 16 to select it.
|-
|| Only narration
|| Double-clicking on a value from a list is a quick way to select or unselect it.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Move the cursor on all the input fields from top to bottom
|| We have entered all the inputs in the '''Input Dock'''.

We are now ready to perform the '''design check'''.
|-
|| Click on the '''Design''' '''button'''
|| Click on the '''Design button '''at the bottom to start the '''design check'''.
|-
|| Only narration
|| In this case, '''Osdag '''will only perform '''design '''with the defined set of inputs.
|-
|| Point toward the '''log messages'''
|| The '''log message''' indicates that the '''design '''is '''unsafe'''.
|-
|| Point towards the '''Output Dock''' and the '''CAD window'''
|| The '''Output Dock''' and '''CAD window''' are inactive as the '''design '''is not successful.
|-
|| Only narration
|| Let us now rectify our '''design '''to arrive at a '''safe design'''.
|-
|| Point toward '''WARNING'''
|| Let us read the '''WARNING'''.
|-
|| Read the '''WARNING '''message
|| The '''WARNING '''message is '''‘The tension force (500.0 kN) exceeds the tension capacity (436.36 kN) with respect to the maximum available plate thickness of 16.0 mm.’'''
|-
|| Point to log messages
|| In this case, the '''design '''has failed is failing due to the '''plate thickness'''.

So, let us increase the '''plate thickness''' and '''re-design'''.
|-
|| Click on the '''Thickness drop-down menu'''
|| Again, '''click '''on the '''Thickness drop-down menu''', and

Select '''Customized.'''
|-
|| Only narration
|| Let us select a thicker plate this time, say 20 '''mm'''.
|-
|| '''Double-click''' on 20
|| '''Double-click''' on 20, and
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below.
|-
|| Click on the '''Design''' '''button'''
|| Click on the '''Design button '''at the bottom to restart the '''design check'''.
|-
|| Point toward the '''log messages'''
|| The '''log message''' now indicates that the '''design '''is '''safe'''.
|-
|| Point towards the '''Output Dock''' and the '''CAD window'''
|| The '''Output Dock''' and '''CAD window''' become active as the '''design '''is now successful.
|-
|| Only narration
|| This brings us to the end of the tutorial.

Let us summarize.
|-
|| '''Slide: '''Summary
|| In this tutorial, we have
* Learnt to perform a''' design check '''
* Interpreted the '''log messages'''
* Rectified '''unsafe design''' using '''log messages'''

* Arrived at a safe design using '''log messages'''

|-
|| '''Slide: '''Assignment
|| As an assignment, please do the following* Design a '''Tension Member''' with a '''welded '''end connection.
* The member carries a '''factored axial force '''of 500 '''kN.'''

|-
|| '''Slide: '''Assignment
||

Perform a '''design check''' by adopting the given design specifications:
* '''Section:'''
** '''Profile: Angles'''
** '''Connection Location: Short Leg'''
** '''Section Size: 150x150x10'''
** '''Material Grade: E 300 (Fe 440)'''
** '''Length: 2560 mm'''

|-
|| '''Slide: '''Assignment
||
* '''Gusset Plate: '''
** '''Thickness: 16 mm'''

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum.
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question.
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
|| * The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India.
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C2/Performing-a-design-check-in-Osdag/English

2023-07-02T18:08:12Z

Anandajitht: Created page with " '''Title of the script:''' Performing a design check in Osdag '''Author''': Monika Soni (script), Anandajith TS (recording) '''Keywords:''' '''Video tutorial, Design check..."

'''Title of the script:''' Performing a design check in Osdag

'''Author''': Monika Soni (script), Anandajith TS (recording)

'''Keywords:''' '''Video tutorial, Design check, Database, Design Process, GUI, Osdag'''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the spoken tutorial on '''Performing a design check in Osdag.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn how to,* Perform a '''design check'''
* Interpret the '''log messages'''
* Rectify '''unsafe''' designs using '''log messages'''
* Arrive at a '''safe '''design using '''log messages'''

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using:* '''Windows 11 Operating System''', and
* '''Osdag v2021.02.a.a12f'''

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have,* '''Osdag''' installed on your system
* Basic knowledge of '''structural steel design'''

If not please access the prerequisite''' '''tutorials available on this website.
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and '''Windows '''is the same.

|-
|| Only narration
|| In this tutorial, We will solve a '''sample design example''' to demonstrate Scenario 2.
|-
|| '''Slide: Sample Design Example'''
|| * '''Design''' a '''Tension Member''' with a '''bolted end connection'''

* The member carries a '''factored axial force '''of '''500 kN'''

* Let’s perform a '''design check''' by adopting the given '''design '''specifications:
* '''Section:'''
** '''Profile: Back to Back Angles'''
** '''Connection Location: Long Leg'''
** '''Section Size: 120x120x12'''
** '''Material Grade: E 250 (Fe 410 W)A'''
** '''Length: 3200 mm'''

|-
|| '''Slide: '''Sample Design Example
|| '''End Connection:'''
** '''Connector: '''
***
**** '''Type: Bolted'''
**** '''Diameter: 16, 20'''
**** '''Bolt Type: Bearing Bolt'''
**** '''Grade: 4.8, 5.8, 6.8'''
** '''Gusset Plate: '''
***
**** '''Thickness: 16 mm'''

|-
|| Only narration
|| Let us switch to '''Osdag'''.
|-
|| Point to Input Dock
|| Now let’s start filling the '''Input Dock''' for our '''sample design'''.
|-
|| Click on the '''Section Profile drop-down menu'''
|| Click on the '''Section Profile''' '''drop-down''' '''menu'''.
|-
|| Select '''Back to Back Angles'''
|| Let’s select '''Back to Back Angles '''from the list of profiles.
|-
|| Click on the '''Conn_Location drop-down menu'''
|| Now, click the '''Conn_Location drop-down menu.'''
|-
|| Select '''Long Leg'''
|| Select '''Long Leg '''from the list.
|-
|| Cursor near Section Size.
|| Now, let us define the '''custom section''' size.
|-
|| Only narration
|| In this case we have to define a 120 x 120 x 12''' Angle section.'''
|-
|| Click on the '''Section Size drop- down''' '''menu '''and select '''Customized.'''
|| Click on the '''Section Size drop-down''' '''menu''', and

Select '''Customized'''.
|-
|| Point toward the '''Customized window'''.
|| The '''Customized window''' opens.
|-
|| Point toward the list of '''Selected sections '''in the '''Customized window'''.
|| Currently, all the '''sections '''are selected by default.
|-
|| Point to the four types of buttons in the window.
|| There are four types of '''buttons '''available for selection.
|-
|| Point toward the '''>> button'''
|| The first '''button '''selects all the sections at once.

It sends all the sections to the '''Selected '''list.
|-
|| Point toward the '''> button'''
|| The second '''button '''selects a single section and sends it to the '''Selected '''list.
|-
|| Point toward the '''< button'''
|| The third '''button '''deselects a single section from the '''Selected '''list.

It sends the section back to the '''Available '''list.
|-
|| Point toward the '''<< button'''
|| And, the fourth '''button '''deselects all the sections at once.

It sends all the sections back to the '''Available '''list.
|-
|| Click on the '''<< button'''
|| Click
on the fourth '''button''' to '''unselect '''all the '''sections '''at once.
|-
|| Point toward the list of '''Available sections '''in the '''Customized window'''.
|| We can select the desired section from the list of '''Available sections. '''
|-
|| '''Scroll '''down multiple times in the list of '''Available sections '''in the '''Customized window'''.
|| '''Scroll '''down the list of '''Available sections '''to locate '''120x120x12.'''
|-
|| Point toward '''120x120x12'''
|| We have located the desired '''section'''.
|-
|| Point to the section.
|| There are two ways to select a '''section:'''

We can either '''double-click''' on a particular '''section '''to select it right away.
|-
|| '''Click '''on '''120x120x12'''
|| Another way is to '''click '''on the desired '''section '''to choose it.
|-
|| Click on the '''> button'''
|| Then '''click '''the second '''button''' to add it to the list of '''Selected sections'''.
|-
|| Point toward '''120x120x12 '''in the '''Selected sections '''list
|| We can now see the '''section '''listed under the '''Selected sections '''on the right.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Only narration
|| Let us now specify the '''Material Grade.'''
|-
|| Click on the '''Material drop-down menu '''and''' '''Select '''E 250 (Fe 410 W)A'''
|| Click on the '''Material drop-down menu''' and select '''E 250 (Fe 410 W)A'''.
|-
|| Type 3200
|| Enter the '''Length '''of the '''member '''as 3200 '''mm'''.
|-
|| '''Factored Loads'''.
|| Let us now define the '''Factored Loads'''.
|-
|| Type 500
|| Enter the value of '''Axial load '''as 500 '''kN'''.
|-
|| Only narration
|| Let us now give input for the '''connector'''.
|-
|| '''Click '''on the '''Diameter drop-down menu '''and

Select '''Customized.'''
|| '''Click '''on the '''Diameter drop-down menu''', and

Select '''Customized.'''
|-
|| Point to the '''Selected list.'''

Move using the '''<< double arrow '''button.
|| Here we see all the diameters in the '''Selected list'''.

Users can move the list to the '''Available''' section.
|-
|| Point toward the '''Available '''list
|| The standard '''Available '''bolt diameters are listed on the left.
|-
|| Only narration
|| Next, we will select the desired diameters from this list.
|-
|| Press '''Ctrl '''and click on 16 and 20
|| Press the '''Ctrl key '''and click on 16 and 20 to select multiple diameters from the list.
|-
|| Click on the '''> button'''
|| Then '''click '''on the second '''button''' to add them to the list of '''Selected diameters'''.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Click on the''' Type drop-down menu '''and select '''Bearing Bolt '''
|| For the '''bolt Type, '''select''' Bearing Bolt.'''

|-
|| Click on the '''Property Class drop-down menu'''
|| '''Click '''on the '''Property Class drop-down menu''', and

Select '''Customized.'''
|-
|| Point toward the '''Selected '''list
|| The standard available bolt '''grades '''are listed on the right.
|-
|| Only narration
|| All the grades are selected by default in the '''Customized '''option.

Let us now deselect the unwanted '''grades '''from this list.
|-
|| Press '''Ctrl '''and click on 3.6, 4.6, 5.6, 8.8, 9.8, 10.9 and 12.9
|| Press the '''Ctrl key '''and click on 3.6, 4.6, 5.6, 8.8, 9.8, 10.9 and 12.9.
|-
|| Click on the '''< button'''
|| Now, '''click '''on the third '''button''' to send them back to the '''Available '''list.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Only narration
|| Let us now define the plate thickness.
|-
|| Click on the '''Thickness drop-down menu'''
|| '''Click '''on the '''Thickness drop-down menu''', and

Select '''Customized.'''
|-
|| Point toward the '''Selected '''list
|| The standard available plate '''thicknesses '''are listed on the right.
|-
|| Only narration
|| Let us now de-select the unwanted '''thicknesses '''from this list.
|-
|| Click on the '''<< button'''
|| Click on the fourth button to de-select all the sections at once.
|-
|| '''Double-click''' on 16
|| Now''', Double-click''' on 16 to select it.
|-
|| Only narration
|| Double-clicking on a value from a list is a quick way to select or unselect it.
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below to confirm and exit.
|-
|| Move the cursor on all the input fields from top to bottom
|| We have entered all the inputs in the '''Input Dock'''.

We are now ready to perform the '''design check'''.
|-
|| Click on the '''Design''' '''button'''
|| Click on the '''Design button '''at the bottom to start the '''design check'''.
|-
|| Only narration
|| In this case, '''Osdag '''will only perform '''design '''with the defined set of inputs.
|-
|| Point toward the '''log messages'''
|| The '''log message''' indicates that the '''design '''is '''unsafe'''.
|-
|| Point towards the '''Output Dock''' and the '''CAD window'''
|| The '''Output Dock''' and '''CAD window''' are inactive as the '''design '''is not successful.
|-
|| Only narration
|| Let us now rectify our '''design '''to arrive at a '''safe design'''.
|-
|| Point toward '''WARNING'''
|| Let us read the '''WARNING'''.
|-
|| Read the '''WARNING '''message
|| The '''WARNING '''message is '''‘The tension force (500.0 kN) exceeds the tension capacity (436.36 kN) with respect to the maximum available plate thickness of 16.0 mm.’'''
|-
|| Point to log messages
|| In this case, the '''design '''has failed is failing due to the '''plate thickness'''.

So, let us increase the '''plate thickness''' and '''re-design'''.
|-
|| Click on the '''Thickness drop-down menu'''
|| Again, '''click '''on the '''Thickness drop-down menu''', and

Select '''Customized.'''
|-
|| Only narration
|| Let us select a thicker plate this time, say 20 '''mm'''.
|-
|| '''Double-click''' on 20
|| '''Double-click''' on 20, and
|-
|| '''Click '''on the '''Submit button'''
|| '''Click '''on the '''Submit button '''below.
|-
|| Click on the '''Design''' '''button'''
|| Click on the '''Design button '''at the bottom to restart the '''design check'''.
|-
|| Point toward the '''log messages'''
|| The '''log message''' now indicates that the '''design '''is '''safe'''.
|-
|| Point towards the '''Output Dock''' and the '''CAD window'''
|| The '''Output Dock''' and '''CAD window''' become active as the '''design '''is now successful.
|-
|| Only narration
|| This brings us to the end of the tutorial.

Let us summarize.
|-
|| '''Slide: '''Summary
|| In this tutorial, we have* Learnt to perform a''' design check '''
* Interpreted the '''log messages'''
* Rectified '''unsafe design''' using '''log messages'''

* Arrived at a safe design using '''log messages'''

|-
|| '''Slide: '''Assignment
|| As an assignment, please do the following* Design a '''Tension Member''' with a '''welded '''end connection.
* The member carries a '''factored axial force '''of 500 '''kN.'''

|-
|| '''Slide: '''Assignment
||

Perform a '''design check''' by adopting the given design specifications:* '''Section:'''
** '''Profile: Angles'''
** '''Connection Location: Short Leg'''
** '''Section Size: 150x150x10'''
** '''Material Grade: E 300 (Fe 440)'''
** '''Length: 2560 mm'''

|-
|| '''Slide: '''Assignment
|| * '''Gusset Plate: '''
** '''Thickness: 16 mm'''

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarizes the Spoken Tutorial Project.

Please download and watch it.
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us.
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum.
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question.
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
|| * The '''Osdag '''team at FOSSEE creates '''sample design examples''' for self-learning
* These examples can be practiced using the '''Osdag''' '''software'''
* For more details, please visit this link [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India.
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off.

Thanks for joining.
|-
|}

Osdag/C2/Introduction-to-Osdag/English

2023-06-29T21:55:06Z

Anandajitht: Created page with "'''Title of the script:''' Introduction to Osdag '''Author''': Anandajith TS, Monika Soni '''Keywords:''''''Video tutorial, Introduction, GUI, Osdag''' {| border=1 |- ||..."

'''Title of the script:''' Introduction to Osdag

'''Author''': Anandajith TS, Monika Soni

'''Keywords:''''''Video tutorial, Introduction, GUI, Osdag'''

{| border=1
|-
|| Visual Cue
|| Narration
|-
|| '''Slide: '''Title Slide
|| Welcome to the spoken tutorial on '''Introduction to Osdag.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn:* '''Modules '''in the current '''version '''
* '''GUI''' of '''Osdag,''' and
* Functionalities of '''Osdag'''

|-
|| '''Slide: '''System Requirements
|| To record this tutorial, I am using* '''Windows 11 Operating System''', and
* Osdag v2021.02.a.a12f

|-
|| '''Slide:''' Pre-requisites

[https://osdag.fossee.in/ https://spoken-tutorial.org]
|| To follow this tutorial you should have* '''Osdag''' installed on your system

The prerequisite''' '''tutorials are available on this website
|-
|| Only narration
|| The user interface of '''Osdag''' for '''Ubuntu Linux''', and for '''Windows '''is same.

Annotations are added to the tutorial if there are any differences.
|-
|| Point to the '''Osdag shortcut icon''' on the desktop
|| We can see the '''Osdag shortcut icon '''on the '''Desktop'''.
|-
|| Cursor pointing to the icon.
|| This '''icon '''will appear only if we have successfully installed '''Osdag'''.
|-
|| '''Double-click''' on the '''Osdag shortcut icon'''
|| Let us start the '''Osdag software '''by double-clicking on the '''Osdag icon'''.
|-
|| Only Narration
|| It may take some time to open '''Osdag '''for the very first time.
|-
|| Point towards the '''Osdag''' '''Interface'''
|| Now we can see the '''Osdag''' interface on the screen.
|-
|| Point to the list of '''modules'''
|| On the left-hand side, we can see the '''list of modules'''.
|-
|| Point toward the '''Connection module '''and''' Tension Member''' '''module'''
|| The current version of '''Osdag '''is shipped with,* The '''Connection''', and
* The '''Tension Member''' '''module'''

|-
|| Only narration
|| The remaining '''modules''' will be released with the subsequent versions of '''Osdag'''.
|-
|| Only narration
|| Let us now explore the functionalities of '''Osdag '''through the '''Connection''' '''module'''.
|-
|| Click on the '''Connection button'''
|| Click on the '''Connection button '''to open the '''module.'''
|-
|| Only narration
|| Under the '''Connection module''', we see four '''tabs'''.
|-
|| Point toward '''Shear''' '''Connection'''
|| The first '''tab '''is the '''Shear Connection''' '''tab'''.
|-
|| Only narration
|| By default, the landing page is on the '''Shear''' '''Connection''' '''tab.'''
|-
|| Click on the '''Moment''' '''Connection tab'''
|| The second''' '''is the '''Moment Connection''' tab.
|-
|| Click on the '''Base Plate tab'''
|| The third '''tab '''is the '''Base Plate '''tab, and
|-
|| Click on the '''Truss''' '''Connection tab'''
|| The fourth '''tab '''is the '''Truss Connection''' tab.
|-
|| Only narration
|| The '''Truss Connection module '''is not available with this version of '''Osdag'''.
|-
|| Only narration
|| All the modules and '''submodules''' are grouped and listed logically for better understanding.
|-
|| Point toward the '''Fin Plate, Cleat Angle, End Plate''' and '''Seated Angle '''image
|| Let us look at the types of '''Shear''' '''Connection module'''. They are,* Fin Plate
* Cleat Angle
* '''End Plate,''' and
* Seated Angle

|-
|| Only narration
|| We will now explore the '''Fin Plate''' '''Shear''' '''Connection''' '''module'''.
|-
|| Click on the '''Fin Plate image'''
|| Click on the '''Fin Plate image '''to select the '''module,''' then
|-
|| Click on the '''Start button'''
|| Click the '''Start''' '''button '''below, to load the '''module'''.
|-
|| Only narration
|| The '''GUI '''of the '''module '''will load dynamically.
|-
|| Fin Plate Connection GUI:

Point toward the '''Fin Plate '''
|| We see the '''design window''' '''GUI''' of the '''Fin''' '''Plate Shear Connection module'''.
|-
|| Only narration
|| Let us perform a '''sample design example '''to explore various functionalities of '''Osdag'''.
|-
|| Fin Plate Connection GUI:

Click on '''File>>''' '''Load input'''
|| Go to the '''File menu''' present at the top left corner, and select '''Load input.'''
|-
|| Open Design Window:

Browse to the '''Code file directory'''
|| Browse to '''Code file directory.'''
|-
|| Open Design Window:

Select the '''FinPlate_sample_design.osi '''file and click on '''Open'''
|| Select '''FinPlate_sample_design.osi '''and

Click the '''Open '''button.
|-
|| Pointing towards filled text boxes
|| As we can see all the inputs have been filled.
|-
|| Fin Plate Connection GUI:

Click on the '''Design button'''
|| Click on the '''Design button '''at the bottom to create the '''design'''.
|-
|| Fin Plate Connection GUI:

Point towards the '''CAD window '''and the '''Log messages window'''
|| The '''design '''is successful as the '''CAD model''' and '''log messages '''are displayed'''.'''
|-
|| Only narration
|| Let us explore the parts of the '''design window '''one by one.
|-
|| Only narration
|| The '''design window '''is divided into four main parts, along with a '''menu bar''' at the top.
|-
|| Fin Plate Connection GUI:

Point toward the '''Input''' '''Dock'''
|| On the left side, we see the '''Input Dock.'''
|-
|| Only narration

Cursor in Input Dock.
|| The '''Input Dock '''is used to give user inputs pertaining to the '''module'''.
|-
|| Input Dock:

Click on any '''drop-down list'''

Click on any '''text box'''
|| It has a combination of '''drop-down '''lists, and '''text boxes'''.

|-
|| Only narration
|| The inputs are validated dynamically based on the '''codal provisions.'''
|-
|| Input Dock:

Point toward '''Connectivity, Factored Loads, Bolt''', and '''Plate '''
|| The '''Input Dock''' has user input fields for* Connectivity
* Factored Loads
* '''Bolt''', and
* Plate

|-
|| Cursor on the input fields.
|| These input fields are custom to the '''Fin Plate Shear Connection module'''.
|-
|| Only narration
|| The input fields will change dynamically depending on the '''module '''type and category.
|-
|| Input Dock:

Click on the '''Reset''' '''button'''
|| The '''Reset''' '''button '''at the bottom is used to reset the selected input values to '''default'''.
|-
|| Point toward the '''Output Dock''' and '''CAD window'''
|| This clears the '''design '''outputs and '''CAD'''.
|-
|| Only narration
|| Let us reload the inputs.
|-
|| Fin Plate Connection GUI:

Click on '''File>>''' '''Load input'''
|| Go to the '''File menu''' and select '''Load input.'''
|-
|| Open Design Window:

Browse to the '''Code file directory'''
|| Browse to the '''Code file directory.'''
|-
|| Open Design Window:

Select the '''FinPlate_sample_design.osi '''file and click on '''Open'''
|| Select '''FinPlate_sample_design.osi '''and

Click the '''Open''' button.
|-
|| Input Dock:

Click on the '''Design button'''
|| Click on the '''Design button'''.

This button is used to run the '''design.'''
|-
|| Output Dock:

Point toward the '''Output Dock'''
|| On the right side of the window, we can see the''' Output Dock.'''
|-
|| Output Dock:

Point toward the '''Bolt '''and '''Plate '''output values in the '''Output Dock'''
|| Outputs for a given '''design '''are detailed in this '''Output Dock '''for interpretation'''.
|-
|| Output Dock:

Point toward the '''Save''' '''Output button'''
|| At the bottom of the '''Output Dock''', we see the''' Save''' '''Output button.'''

|-
|| Only narration
|| It allows us to save the '''design '''outputs in a '''text file'''.
|-
|| Output Dock:

Point toward the '''Create Design Report''' '''button'''
|| Above the '''Save''' '''Output button, '''we see the '''Create Design Report button'''.
|-
|| Only narration
|| It allows us to export the '''design report '''as '''PDF'''.
|-
|| Only narration
|| We will learn how to create and interpret '''design reports''' in another tutorial.
|-
|| Graphics window:

Point toward the '''Graphics''' '''window'''
|| The '''window '''at the centre is the '''3D''' '''Graphics window.'''
|-
|| Graphics window:

Rotate the '''3D model '''in the '''Graphics''' '''window'''
|| The '''Graphics window '''displays the '''3D CAD model''' of the module for visualisation.
|-
|| Only narration
|| The '''3D CAD model''' is displayed if and only if the '''design '''is safe.
|-
|| Only narration
|| We will learn to handle the '''3D CAD model''' in another tutorial.
|-
|| Message window:

Point toward the '''Log message''' '''window'''
|| '''Log messages '''pertaining to a design session are displayed in the '''Log message''' '''window. '''
|-
|| Message window:

Highlight the '''log message'''
|| It''' '''displays colour-coded messages in the form of '''ERRORS, WARNINGS '''and '''INFO.'''
|-
|| Only narration
|| It also gives suggestions to arrive at a safe '''design '''to a novice user.
|-
|| Only narration
|| We will see how to use these logs to rectify '''unsafe design'''s in another tutorial.
|-
|| Fin Plate Connection GUI:

Click on the hide-unhide '''Input/Output''' '''Dock buttons'''
|| There is a hide-unhide '''toggle '''above the '''Graphics window.'''

This toggle''' '''is used to hide and unhide the '''Input''' and the '''Output''' dock respectively.
|-
|| Fin Plate Connection GUI:

Click on the''' ZX '''and '''ZY 2D''' '''view''' '''buttons.'''

Point to the tooltips.
|| The '''2D view buttons '''at the top display the '''2D '''view of the '''CAD model'''.

The tooltips show the views.
|-
|| Fin Plate Connection GUI:

Click on the '''Beam, Column and fin plate check-box'''
|| The component '''checkbox '''displays an isolated '''3D '''view of each''' component''' individually.
|-
|| Only narration
|| This allows us to visualise minute details of the '''connection'''.
|-
|| Output Dock:

Point towards''' Output Dock'''
|| The '''Output Dock''' on the right side displays the relevant '''design '''outputs.
|-
|| Fin Plate Connection GUI:

Point toward the '''Menu bar'''
|| On the top left side of the '''GUI''', we can see a '''menu bar.'''

It has '''menu '''options for* File
* Edit
* Graphics
* '''Database '''and
* '''Help'''.

|-
|| Cursor on the File and Edit menus
|| We will explore File, Edit and Graphics menus in another tutorial
|-
|| Only narration
|| Here, let us explore the Database and Help menus
|-
|| Click on the '''Database menu'''
|| Click on the '''Database menu'''.
|-
|| Database menu:

Point toward '''Download'''
|| The '''steel sections database''' of '''Osdag '''can be downloaded using the '''Download menu'''.
|-
|| Database menu:

Point toward '''Column, Beam, Angle, Channel'''
|| Database for Column, Beam, Angle and Channel sections can be downloaded separately
|-
|| Database menu:

Only narration
|| Users can edit the '''database '''to add custom sections and upload it back to '''Osdag'''.
|-
|| Database menu:

Only narration
|| Database can be uploaded using the Edit and Design Preference menu
|-
|| Database menu:

Only narration
|| In this way, users can perform '''design '''by using a custom section.
|-
|| Database menu:

Point toward the '''Reset '''menu
|| The '''Reset '''menu will reset the database to default
|-
|| Click on the '''Help menu'''
|| Let us now explore the '''Help menu'''.
|-
|| Help menu:

Point toward '''Video Tutorials '''and '''Design Examples menu'''
|| Through the '''Help''' '''menu''', users can access '''Video Tutorials and '''sample '''Design Examples.'''
|-
|| Only narration
|| These are self learning materials created and made freely available with the '''software'''.
|-
|| Only narration
|| Please check them out
|-
|| Help menu:

Point toward '''Ask us a Question'''
|| Users can write their query to the '''Osdag''' team through the''' Ask us a Question '''menu
|-
|| Only narration
|| You will be redirected to the forum where you can register and post your queries
|-
|| Only narration
|| The query will be answered by the team or other users
|-
|| '''Help menu: '''Point toward '''About Osdag''' and '''Check For Update'''
|| You can also check for '''software versions, about''' and '''updates'''
|-
|| Only narration
|| This brings us to the end of the tutorial.

Let us summarise.
|-
|| '''Slide: '''Summary
|| In this tutorial, we have * Learnt various''' modules '''in current version
* Reviewed the''' GUI,''' and
* Explored the functionalities

|-
|| '''Slide: '''Assignment
|| As an '''assignment''', Explore,* '''User interface''' of other '''modules'''
* '''Design Examples '''page, and
* '''Discussion Forum '''page

|-
|| '''Slide: '''About Spoken Tutorial Project
|| The video at the following link summarises the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:'''Spoken Tutorial Workshops
|| The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
|| '''Slide:'''Answers for THIS Spoken Tutorial
|| Please post your timed queries in this forum
|-
|| '''Slide: '''FOSSEE Forum
|| For any general or technical questions on '''Osdag''', visit the '''FOSSEE '''forum and post your question
|-
|| '''Slide: '''Sample Design Examples

[https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]
|| * The '''Osdag '''team at '''FOSSEE '''creates '''sample design examples''' for self-learning
* These examples can be practised using the '''Osdag''' '''software'''
* For more details, please visit the link below [https://osdag.fossee.in/resources/sample-design https://osdag.fossee.in/resources/sample-design]

|-
|| '''Slide: '''Acknowledgement
|| The '''Spoken''''''Tutorial'''project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide: '''Thank you
|| This is '''Anandajith TS''', FOSSEE IIT Bombay signing off

Thanks for joining
|-
|}

Osdag/C2/Installation-of-Osdag-in-Windows/English

2023-05-17T06:41:13Z

Anandajitht:

'''Title of the script:''' '''Installation of Osdag in Windows'''

'''Author''': Zahran Sajid

'''Keywords: Osdag, Installation, Windows OS, Miniconda, sample design, Fin Plate, CAD model, conda, video tutorial'''

{|border=1
| align=center| Visual Cue
| align=center| Narration
|-
| '''Slide:''' Title Slide
| Welcome to the spoken tutorial on '''‘Installation of Osdag in Windows’.'''
|-
| '''Slide:''' Learning Objectives
|
In this tutorial, we will learn to

* Download and Install '''Osdag''' in '''Windows''' '''Operating System'''
* Open '''Osdag''' through '''Osdag shortcut icon'''
* Verify the installation
|-
| '''Slide:''' System Requirement
|
To record this tutorial, I am using:

* '''Windows 11''',
* '''Osdag''' version '''v2021.02.a.a12f''', and
* A working '''internet''' connection
|-
| '''Slide:''' Pre-requisites
|
To follow this tutorial, the user should be familiar with

* Basics of '''structural steel design'''
|-
| '''Slide:''' Hardware Requirements
|
For a successful installation, we need

* '''Windows 10''' (or later version)
* Minimum of 4 '''GB''' '''RAM''', and
* Minimum of 4 '''GB''' '''hard disk''' space
|-
| Only narration
|
Let us first download the '''installer''' file from the '''Osdag''' website.

Open any '''web browser''' of your choice.
|-
| Open '''Mozilla Firefox'''
| I have opened the '''Mozilla Firefox web browser'''.
|-
|
Type ‘'''osdag.fossee.in'''’ and

press '''Enter'''.
|
In the '''address bar''' type the '''URL ‘osdag.fossee.in’''' and

press '''Enter.'''
|-
| Only Narration
| We see the homepage of the '''Osdag''' website.
|-
|
'''Mozilla Firefox:'''

Click on “'''Downloads'''”
| In the top '''menu bar''', click on the '''Downloads''' '''tab'''.
|-
| Point toward the '''Downloads''' page
|
We will be redirected to the '''Downloads''' page.

The '''Osdag installer''' for '''Ubuntu''' '''Linux''' and '''Windows operating system''' is listed here.
|-
| Scroll and point towards the release dates
| The '''installers''' are listed according to their release date.
|-
| Point towards '''1. Installer [Release: 2021-02-15]'''
| The topmost '''installer''' is for the latest '''version''' of '''Osdag'''.
|-
| Only Narration
| Older versions of '''Osdag''' are listed below.
|-
|
'''Mozilla Firefox:'''

Click on '''Installer-Windows'''
| Click on the '''Installer-Windows''' link.
|-
| Only Narration
| We will be redirected to the '''Osdag User Information Form''' page.
|-
|
'''Mozilla Firefox:'''

Show filled '''Osdag User Information Form'''
|
To download the '''Osdag Installer''', the required details must be filled in.

I have already filled the '''form'''.
|-
| Only Narration
|
The details will be used for internal '''quality assessment''' purposes only.

So, please do not hesitate to submit the details.
|-
| Click on '''Submit'''
| Click on '''Submit''' at the end of the '''form''' to start downloading '''Osdag installer'''.
|-
| Point toward the '''Osdag_windows_installer_v2021.02.a.a12f.zip''' file in '''Downloads'''
| '''Osdag''' installer is now downloaded and saved to the '''Downloads folder''' on my system.
|-
| Only Narration
| Let us proceed with the installation.
|-
| '''Right-click''' on '''Osdag_windows_installer_v2021.02.a.a12f.zip''' file and select '''Extract All'''
| To '''extract''' the '''installer''' file, right-click on it and select '''Extract All.'''
|-
| Only Narration
| Users can '''extract''' the file to any other folder of their choice.
|-
|
'''Extract Compressed (Zipped) Folders window:'''

Click on '''Extract'''
| Click on the '''Extract''' button at the bottom right corner.
|-
| '''Double-click''' on the '''Osdag_windows_installer_v2021.02.a.a12f''' folder
| After it is completed, double click on the '''extracted''' folder to open it.
|-
| '''Double-click''' on the '''Osdag_windows_installer_v2021.02.a.a12f''' folder
| Double click on the folder inside to open it.
|-
| '''Right-click''' on '''Osdag_windows_setup''' file and select as '''Run as administrator'''
|
Right-click on the '''Osdag_windows_setup''' file.

Select '''Run as administrator option.'''
|-
| '''Click''' on '''Yes''' in the '''pop-up window'''
|
A '''window''' will pop-up asking for confirmation.

Click on '''Yes''' to accept and proceed.
|-
| Point toward the '''Osdag Setup Wizard'''
| We see the '''Osdag Setup Wizard.'''
|-
| Only Narration
| The '''Setup Wizard''' will guide us through the installation of '''Osdag'''.
|-
|
'''Osdag Setup Wizard:'''

'''Click''' on '''Next'''
| Click on the '''Next''' button below to proceed.
|-
|
'''Osdag Setup Wizard:'''

Point toward the '''License''' '''agreement''' page
| We see the '''License Agreement''' page of Osdag'''.'''
|-
|
'''Osdag Setup Wizard:'''

'''Click I agree button'''.
| Click on the '''I agree button''' below to accept the terms of the agreement and continue.
|-
|
'''Osdag Setup Wizard:'''

Point toward '''Destination Folder''' location
| The '''Setup Wizard''' will ask for the location for installing '''Osdag'''.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Browse button'''
| Click on '''Browse''' to select a location.
|-
| Only Narration
| I will select the '''C drive'''. Users may select any directory of their choice.
|-
|
'''Browse For Folder:'''

Click on '''This PC dropdown''' and '''C:'''

Click on '''Ok'''
|
To choose the location, I will select '''This PC''' and then the '''C''' drive.

I will then click on '''Ok'''.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Next button'''
|
We have selected the location.

Now click on the '''Next button''' below to continue.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Install button'''
|
We are ready to start the installation.

Click on the '''Install button''' below to start.
|-
| Only Narration
|
The installation process has now started.

It may take some time depending on the '''internet''' speed.
|-
|
'''Slide:'''

Installation Steps
|
The '''installer''' installs the following in a sequence

* '''Miniconda'''
* '''Python''' '''dependencies'''
* '''MiKTeX''', and
* '''Osdag'''
|-
|
'''Slide:'''

What is '''Miniconda'''?
|
* '''Conda''' is a '''cross-platform package manager'''
* '''Miniconda''' is a minimal installer for conda
* '''Conda''' installs, runs and updates the '''packages''' and their '''dependencies'''
|-
|
'''Slide:'''

What is '''MiKTeX'''?
|
* '''MiKTeX''' is a '''typesetting software'''
* It provides the tools to produce documents using the '''TeX markup language'''
|-
| Switch back to the '''Osdag Setup Wizard'''
| I will go back to the '''Osdag Setup Wizard.'''
|-
|
'''Basic MiKTeX Installer:'''

Point toward the '''window'''
| We see the '''Basic MiKTeX Installer window.'''
|-
|
'''Basic MiKTeX Installer:'''

'''Check''' the ‘'''I accept the MiKTeX copying conditions’ checkbox''' and click on the '''Next button'''
|
Check the ‘'''I accept the MiKTeX copying conditions’ checkbox''' to accept the conditions<s>,</s>

Click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
| Keep the '''default''' selection and click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Point toward the '''path'''
| '''MiKTeX''' will ask to choose a location for the '''installation directory'''.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
| Again, keep it to '''default''' selection and click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
| Keep the '''preferences''' selection to '''default''' and click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Start button'''
| Click on the '''Start button''' below to start the installation of '''MiKTeX.'''
|-
| Only Narration
| The installation process of '''MiKTeX''' has now started.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
|
The installation of '''MiKTeX''' is now complete.

Click on the '''Next button''' below to proceed.
|-
|
'''Basic MiKTeX Installer:'''

'''Uncheck''' the '''‘Check for updates now’ checkbox''' and click on '''OK'''
|
We will check for '''updates''' later.

Uncheck the '''‘Check for updates now’ checkbox''' and click on '''OK.'''
|-
|
'''Basic MiKF Installer:'''

Click on the '''Next button'''
| Click on the '''Next button''' below.
|-
|
'''Basic MiKTeX Installer:'''

'''Uncheck''' the ‘'''Tell me more’ checkbox''' and click on '''Close'''
|
'''Uncheck''' the '''‘Tell me more’ checkbox''' and

Click on the '''Close button''' below to exit the '''Wizard'''.
|-
|
'''Osdag Setup Wizard:'''

Only Narration
| The installation process will now continue.
|-
|
'''Osdag Setup Wizard:'''

Point toward the message '''‘Osdag has been installed on your computer’'''
| '''Osdag''' has been installed successfully.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Finish button'''
| Click on the '''Finish button''' below to close the '''Osdag Setup Wizard.'''
|-
|
'''Osdag Setup:'''

Point toward the '''pop-up message'''
| A '''pop-up window''' shows that we have successfully installed '''Osdag''' on our system.
|-
|
'''Osdag Setup:'''

Click on the '''OK button'''
| Click on the '''OK button''' to exit.
|-
| Only Narration
|
We can open '''Osdag''' using

* '''Osdag shortcut icon on Desktop.'''
* '''Start menu''', or
* '''Osdag shortcut''' in the '''Osdag installation directory.'''
|-
|
'''Desktop:'''

Click on '''Desktop'''
| I will now go to the '''Desktop''' on my system'''.'''
|-
|
'''Desktop:'''

Point toward the '''Osdag shortcut icon''' on '''Desktop'''
|
A '''Osdag shortcut icon''' is created on the '''Desktop''' by default.

Let us open '''Osdag''' using this '''shortcut icon'''.
|-
|
'''Desktop:'''

'''Double-click''' on the '''Osdag shortcut icon'''
| '''Double-click''' on the '''Osdag shortcut icon.'''
|-
| Only Narration
| It may take some time to open '''Osdag''' for the very first time.
|-
| Point towards the '''Osdag''' '''Interface'''
| Now we can see the '''Osdag''' interface on the screen.
|-
| Only narration
| Let us validate the installation by running a '''sample design example'''.
|-
|
'''Osdag:'''

Click on the '''Connection module'''
| Click on the '''Connection module''' present at the top left side.
|-
| Click on '''Fin Plate''' image
| Click on the '''Fin Plate''' image to select the '''module,''' and
|-
| Click on '''Start.'''
| Click on the '''Start button''' below to launch the '''module.'''
|-
| Only narration
| The '''module''' might take some time to launch.
|-
|
'''Fin Plate Connection GUI:'''

Click on '''File>>''' '''Load input'''
| Go to the '''File menu''' present at the top left corner, and select '''Load input.'''
|-
|
'''Open Design Window:'''

Browse to the '''Code file directory'''
| I will browse to the '''Code file directory.'''
|-
|
'''Open Design Window:'''

Select the '''FinPlate_sample_design.osi''' file and click on '''Open'''
|
Select '''FinPlate_sample_design.osi,''' and

Click on '''Open.'''
|-
| Point toward the '''Input Dock fields'''
| We see the input values are populated for our '''sample design example'''.
|-
| Only narration
| We are now ready to perform the '''design'''.
|-
|
'''Fin Plate Connection GUI:'''

Click on the '''Design button'''
| Click on the '''Design button''' at bottom to start.
|-
|
'''Fin Plate Connection GUI:'''

Point towards the '''CAD window''' and the '''Log messages window'''
| Osdag will display the '''CAD model''' and print '''log messages.'''
|-
| Only narration
|
This means that the '''design''' is complete.

It indicates that the installation of '''Osdag''' is successful.
|-
| Only narration
|
This brings us to the end of this tutorial.

Let us summarise.
|-
| '''Slide:''' Summary
|
In this tutorial, we have

* Downloaded and installed '''Osdag''' in '''Windows''' '''operating system'''
* Opened '''Osdag''' through '''Osdag shortcut icon'''
* Verified the installation
|-
| '''Slide:''' About Spoken Tutorial Project
|
The video at the following link summarises the Spoken Tutorial Project

Please download and watch it
|-
| '''Slide:''' Spoken Tutorial Workshops
|
The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
| '''Slide:''' Answers for THIS Spoken Tutorial
| Please post your timed queries in this forum
|-
| '''Slide:''' FOSSEE Forum
| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
| '''Slide:''' Acknowledgements
| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
| '''Slide:''' Thank you
|
This is '''Zahran Sajid''', a FOSSEE summer fellow 2022, IIT Bombay signing off

Thanks for joining
|}

Osdag/C2/Installation-of-Osdag-in-Windows/English

2023-05-16T18:22:57Z

Anandajitht: Created page with "'''Title of the script:''' '''Installation of Osdag in Windows''' '''Author''': Zahran Sajid '''Keywords: Osdag, Installation, Windows 10, video tutorial''' {|border=1 | a..."

'''Title of the script:''' '''Installation of Osdag in Windows'''

'''Author''': Zahran Sajid

'''Keywords: Osdag, Installation, Windows 10, video tutorial'''

{|border=1
| align=center| Visual Cue
| align=center| Narration
|-
| '''Slide:''' Title Slide
| Welcome to the spoken tutorial on '''‘Installation of Osdag in Windows’.'''
|-
| '''Slide:''' Learning Objectives
|
In this tutorial, we will learn to

* Download and Install '''Osdag''' in '''Windows''' '''Operating System'''
* Open '''Osdag''' through '''Osdag shortcut icon'''
* Verify the installation
|-
| '''Slide:''' System Requirement
|
To record this tutorial, I am using:

* '''Windows 11''',
* '''Osdag''' version '''v2021.02.a.a12f''', and
* A working '''internet''' connection
|-
| '''Slide:''' Pre-requisites
|
To follow this tutorial, the user should be familiar with

* Basics of '''structural steel design'''
|-
| '''Slide:''' Hardware Requirements
|
For a successful installation, we need

* '''Windows 10''' (or later version)
* Minimum of 4 '''GB''' '''RAM''', and
* Minimum of 4 '''GB''' '''hard disk''' space
|-
| Only narration
|
Let us first download the '''installer''' file from the '''Osdag''' website.

Open any '''web browser''' of your choice.
|-
| Open '''Mozilla Firefox'''
| I have opened the '''Mozilla Firefox web browser'''.
|-
|
Type ‘'''osdag.fossee.in'''’ and

press '''Enter'''.
|
In the '''address bar''' type the '''URL ‘osdag.fossee.in’''' and

press '''Enter.'''
|-
| Only Narration
| We see the homepage of the '''Osdag''' website.
|-
|
'''Mozilla Firefox:'''

Click on “'''Downloads'''”
| In the top '''menu bar''', click on the '''Downloads''' '''tab'''.
|-
| Point toward the '''Downloads''' page
|
We will be redirected to the '''Downloads''' page.

The '''Osdag installer''' for '''Ubuntu''' '''Linux''' and '''Windows operating system''' is listed here.
|-
| Scroll and point towards the release dates
| The '''installers''' are listed according to their release date.
|-
| Point towards '''1. Installer [Release: 2021-02-15]'''
| The topmost '''installer''' is for the latest '''version''' of '''Osdag'''.
|-
| Only Narration
| Older versions of '''Osdag''' are listed below.
|-
|
'''Mozilla Firefox:'''

Click on '''Installer-Windows'''
| Click on the '''Installer-Windows''' link.
|-
| Only Narration
| We will be redirected to the '''Osdag User Information Form''' page.
|-
|
'''Mozilla Firefox:'''

Show filled '''Osdag User Information Form'''
|
To download the '''Osdag Installer''', the required details must be filled in.

I have already filled the '''form'''.
|-
| Only Narration
|
The details will be used for internal '''quality assessment''' purposes only.

So, please do not hesitate to submit the details.
|-
| Click on '''Submit'''
| Click on '''Submit''' at the end of the '''form''' to start downloading '''Osdag installer'''.
|-
| Point toward the '''Osdag_windows_installer_v2021.02.a.a12f.zip''' file in '''Downloads'''
| '''Osdag''' installer is now downloaded and saved to the '''Downloads folder''' on my system.
|-
| Only Narration
| Let us proceed with the installation.
|-
| '''Right-click''' on '''Osdag_windows_installer_v2021.02.a.a12f.zip''' file and select '''Extract All'''
| To '''extract''' the '''installer''' file, right-click on it and select '''Extract All.'''
|-
| Only Narration
| Users can '''extract''' the file to any other folder of their choice.
|-
|
'''Extract Compressed (Zipped) Folders window:'''

Click on '''Extract'''
| Click on the '''Extract''' button at the bottom right corner.
|-
| '''Double-click''' on the '''Osdag_windows_installer_v2021.02.a.a12f''' folder
| After it is completed, double click on the '''extracted''' folder to open it.
|-
| '''Double-click''' on the '''Osdag_windows_installer_v2021.02.a.a12f''' folder
| Double click on the folder inside to open it.
|-
| '''Right-click''' on '''Osdag_windows_setup''' file and select as '''Run as administrator'''
|
Right-click on the '''Osdag_windows_setup''' file.

Select '''Run as administrator option.'''
|-
| '''Click''' on '''Yes''' in the '''pop-up window'''
|
A '''window''' will pop-up asking for confirmation.

Click on '''Yes''' to accept and proceed.
|-
| Point toward the '''Osdag Setup Wizard'''
| We see the '''Osdag Setup Wizard.'''
|-
| Only Narration
| The '''Setup Wizard''' will guide us through the installation of '''Osdag'''.
|-
|
'''Osdag Setup Wizard:'''

'''Click''' on '''Next'''
| Click on the '''Next''' button below to proceed.
|-
|
'''Osdag Setup Wizard:'''

Point toward the '''License''' '''agreement''' page
| We see the '''License Agreement''' page of Osdag'''.'''
|-
|
'''Osdag Setup Wizard:'''

'''Click I agree button'''.
| Click on the '''I agree button''' below to accept the terms of the agreement and continue.
|-
|
'''Osdag Setup Wizard:'''

Point toward '''Destination Folder''' location
| The '''Setup Wizard''' will ask for the location for installing '''Osdag'''.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Browse button'''
| Click on '''Browse''' to select a location.
|-
| Only Narration
| I will select the '''C drive'''. Users may select any directory of their choice.
|-
|
'''Browse For Folder:'''

Click on '''This PC dropdown''' and '''C:'''

Click on '''Ok'''
|
To choose the location, I will select '''This PC''' and then the '''C''' drive.

I will then click on '''Ok'''.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Next button'''
|
We have selected the location.

Now click on the '''Next button''' below to continue.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Install button'''
|
We are ready to start the installation.

Click on the '''Install button''' below to start.
|-
| Only Narration
|
The installation process has now started.

It may take some time depending on the '''internet''' speed.
|-
|
'''Slide:'''

Installation Steps
|
The '''installer''' installs the following in a sequence

* '''Miniconda'''
* '''Python''' '''dependencies'''
* '''MiKTeX''', and
* '''Osdag'''
|-
|
'''Slide:'''

What is '''Miniconda'''?
|
* '''Conda''' is a '''cross-platform package manager'''
* '''Miniconda''' is a minimal installer for conda
* '''Conda''' installs, runs and updates the '''packages''' and their '''dependencies'''
|-
|
'''Slide:'''

What is '''MiKTeX'''?
|
* '''MiKTeX''' is a '''typesetting software'''
* It provides the tools to produce documents using the '''TeX markup language'''
|-
| Switch back to the '''Osdag Setup Wizard'''
| I will go back to the '''Osdag Setup Wizard.'''
|-
|
'''Basic MiKTeX Installer:'''

Point toward the '''window'''
| We see the '''Basic MiKTeX Installer window.'''
|-
|
'''Basic MiKTeX Installer:'''

'''Check''' the ‘'''I accept the MiKTeX copying conditions’ checkbox''' and click on the '''Next button'''
|
Check the ‘'''I accept the MiKTeX copying conditions’ checkbox''' to accept the conditions<s>,</s>

Click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
| Keep the '''default''' selection and click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Point toward the '''path'''
| '''MiKTeX''' will ask to choose a location for the '''installation directory'''.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
| Again, keep it to '''default''' selection and click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
| Keep the '''preferences''' selection to '''default''' and click on the '''Next button''' below to continue.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Start button'''
| Click on the '''Start button''' below to start the installation of '''MiKTeX.'''
|-
| Only Narration
| The installation process of '''MiKTeX''' has now started.
|-
|
'''Basic MiKTeX Installer:'''

Click on the '''Next button'''
|
The installation of '''MiKTeX''' is now complete.

Click on the '''Next button''' below to proceed.
|-
|
'''Basic MiKTeX Installer:'''

'''Uncheck''' the '''‘Check for updates now’ checkbox''' and click on '''OK'''
|
We will check for '''updates''' later.

Uncheck the '''‘Check for updates now’ checkbox''' and click on '''OK.'''
|-
|
'''Basic MiKF Installer:'''

Click on the '''Next button'''
| Click on the '''Next button''' below.
|-
|
'''Basic MiKTeX Installer:'''

'''Uncheck''' the ‘'''Tell me more’ checkbox''' and click on '''Close'''
|
'''Uncheck''' the '''‘Tell me more’ checkbox''' and

Click on the '''Close button''' below to exit the '''Wizard'''.
|-
|
'''Osdag Setup Wizard:'''

Only Narration
| The installation process will now continue.
|-
|
'''Osdag Setup Wizard:'''

Point toward the message '''‘Osdag has been installed on your computer’'''
| '''Osdag''' has been installed successfully.
|-
|
'''Osdag Setup Wizard:'''

Click on the '''Finish button'''
| Click on the '''Finish button''' below to close the '''Osdag Setup Wizard.'''
|-
|
'''Osdag Setup:'''

Point toward the '''pop-up message'''
| A '''pop-up window''' shows that we have successfully installed '''Osdag''' on our system.
|-
|
'''Osdag Setup:'''

Click on the '''OK button'''
| Click on the '''OK button''' to exit.
|-
| Only Narration
|
We can open '''Osdag''' using

* '''Osdag shortcut icon on Desktop.'''
* '''Start menu''', or
* '''Osdag shortcut''' in the '''Osdag installation directory.'''
|-
|
'''Desktop:'''

Click on '''Desktop'''
| I will now go to the '''Desktop''' on my system'''.'''
|-
|
'''Desktop:'''

Point toward the '''Osdag shortcut icon''' on '''Desktop'''
|
A '''Osdag shortcut icon''' is created on the '''Desktop''' by default.

Let us open '''Osdag''' using this '''shortcut icon'''.
|-
|
'''Desktop:'''

'''Double-click''' on the '''Osdag shortcut icon'''
| '''Double-click''' on the '''Osdag shortcut icon.'''
|-
| Only Narration
| It may take some time to open '''Osdag''' for the very first time.
|-
| Point towards the '''Osdag''' '''Interface'''
| Now we can see the '''Osdag''' interface on the screen.
|-
| Only narration
| Let us validate the installation by running a '''sample design example'''.
|-
|
'''Osdag:'''

Click on the '''Connection module'''
| Click on the '''Connection module''' present at the top left side.
|-
| Click on '''Fin Plate''' image
| Click on the '''Fin Plate''' image to select the '''module,''' and
|-
| Click on '''Start.'''
| Click on the '''Start button''' below to launch the '''module.'''
|-
| Only narration
| The '''module''' might take some time to launch.
|-
|
'''Fin Plate Connection GUI:'''

Click on '''File>>''' '''Load input'''
| Go to the '''File menu''' present at the top left corner, and select '''Load input.'''
|-
|
'''Open Design Window:'''

Browse to the '''Code file directory'''
| I will browse to the '''Code file directory.'''
|-
|
'''Open Design Window:'''

Select the '''FinPlate_sample_design.osi''' file and click on '''Open'''
|
Select '''FinPlate_sample_design.osi,''' and

Click on '''Open.'''
|-
| Point toward the '''Input Dock fields'''
| We see the input values are populated for our '''sample design example'''.
|-
| Only narration
| We are now ready to perform the '''design'''.
|-
|
'''Fin Plate Connection GUI:'''

Click on the '''Design button'''
| Click on the '''Design button''' at bottom to start.
|-
|
'''Fin Plate Connection GUI:'''

Point towards the '''CAD window''' and the '''Log messages window'''
| Osdag will display the '''CAD model''' and print '''log messages.'''
|-
| Only narration
|
This means that the '''design''' is complete.

It indicates that the installation of '''Osdag''' is successful.
|-
| Only narration
|
This brings us to the end of this tutorial.

Let us summarise.
|-
| '''Slide:''' Summary
|
In this tutorial, we have

* Downloaded and installed '''Osdag''' in '''Windows''' '''operating system'''
* Opened '''Osdag''' through '''Osdag shortcut icon'''
* Verified the installation
|-
| '''Slide:''' About Spoken Tutorial Project
|
The video at the following link summarises the Spoken Tutorial Project

Please download and watch it
|-
| '''Slide:''' Spoken Tutorial Workshops
|
The Spoken Tutorial Project team conducts workshops and gives certificates

For more details, please write to us
|-
| '''Slide:''' Answers for THIS Spoken Tutorial
| Please post your timed queries in this forum
|-
| '''Slide:''' FOSSEE Forum
| For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
| '''Slide:''' Acknowledgements
| The '''Spoken''' '''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
| '''Slide:''' Thank you
|
This is '''Zahran Sajid''', a FOSSEE summer fellow 2022, IIT Bombay signing off

Thanks for joining
|}

Osdag/C2/Installation-of-Osdag-in-Ubuntu/English

2023-04-17T19:40:19Z

Anandajitht: Created page with "'''Title of the script''': '''Installation of Osdag in Ubuntu''' '''Author''': Zahran Sajid '''Keywords:''' Osdag, Installation, Ubuntu Linux, Osdag, Terminal, text editor,..."

'''Title of the script''': '''Installation of Osdag in Ubuntu'''

'''Author''': Zahran Sajid

'''Keywords:''' Osdag, Installation, Ubuntu Linux, Osdag, Terminal, text editor, video tutorial.

{|border=1
| align=center| Visual Cue
| align=center| Narration
|-
||'''Slide:'''

'''Title Slide
|| Welcome to the spoken tutorial on '''‘Installation''' '''of Osdag in Ubuntu’.'''
|-
|| '''Slide: '''Learning Objectives
|| In this tutorial, we will learn to:
* Download and install '''Osdag''' in '''Ubuntu Linux OS'''
* Open '''Osdag '''through '''Terminal'''
* Verify the installation

|-
|| '''Slide:'''

'''System Requirements'''
|| To record this tutorial, I am using:* '''Ubuntu Linux''' '''20.04'''
* '''Osdag''' version''' v2021.02.a.a12f'''
* '''gedit '''text editor''', '''and
* A working '''internet '''connection

|-
|| '''Slide:'''

'''Pre-requisites

[https://spoken-tutorial.org/ https://spoken-tutorial.org]
|| To follow this tutorial, the user should be familiar with,
* Basic '''Linux '''commands
* A text editor in '''Linux''', and
* Basics of '''structural steel design'''

For prerequisite '''Linux''' and '''gedit Text Editor '''tutorials please visit this website.
|-
||'''Slide:'''
'''Hardware Requirements'''
|| For a successful installation, we will need
* 64-'''bit''' '''Ubuntu Linux''' (18.04 or later version)
* Minimum of 4''' GB''' '''RAM'''
* Minimum of 4 '''GB''' '''hard disk''' space

|-
|| '''Slide: '''Code Files
||
* The files used in this tutorial are available in the'''Code Files '''
* Please download and extract them
* Make a copy and then use them while practising

|-
|| Show '''commands.txt '''using '''gedit'''
|| I have opened the '''commands.txt''' file in the '''gedit text editor''' on my system.

You may use any other '''editor''' of your choice.
|-
|| Only Narration

Press '''Ctrl, Shift, '''and '''V ''' keys to paste in the Terminal.
|| I will use the same file to copy the '''commands''' during the demonstration.

'''Commands''' on the '''terminal''' can be pasted by pressing '''Ctrl, Shift''', and '''V ''' keys together.
|-
||Only Narration
|| Let us first download the '''installer''' file from the '''Osdag''' website.

Open any '''web browser '''of your choice.
|-
|| Open '''Mozilla Firefox'''
|| I have opened the '''Mozilla Firefox''' web browser.
|-
|| Type''' '''‘'''osdag.fossee.in'''’ and press '''Enter'''
|| In the '''address bar''' type the '''URL ‘osdag.fossee.in’''' and press '''Enter'''.
|-
|| Cursor on the homepage of '''Osdag'''.
||We see the homepage of the '''Osdag ''' website.
|-
|| '''Mozilla Firefox:'''

Click on “'''Downloads'''” tab.
|| In the top '''menu bar''', click on the '''Downloads''' tab'''.
|-
|| Point toward the '''Downloads''' page
||We will be redirected to the '''Downloads''' page.

The ''' Osdag installers''' for '''Ubuntu Linux''' and '''Windows OS ''' are listed here.
|-
||Scroll and point towards the release dates.
||The '''installers''' are listed according to their release date.
|-
|| Point towards '''1. Installer [Release: 2021-02-15]'''
||The topmost '''installer ''' is for the latest '''version '''of '''Osdag.'''
|-
||Scroll the page to show the older versions.
|| Older versions of '''Osdag '''are listed below.
|-
|| '''Mozilla Firefox:'''

Click on '''Installer-Linux'''
|| Click on the '''Installer-Linux '''link.
|-
||Only Narration
|| We will be redirected to the '''Osdag User Information Form '''page.
|-
|| '''Mozilla Firefox:'''

Show filled '''Osdag User Information Form'''

|| To download the '''Osdag '''Installer, the required details must be filled in.

I have already filled the '''form.'''

|-
||Only Narration
|| The details will be used for internal '''quality assessment''' purposes only.

So, please do not hesitate to submit the details.
|-
|| Click on '''Submit'''
||Click on '''Submit''' at the end of the '''form '''to start downloading the '''Osdag installer.'''
|-
|| Point toward the '''Osdag_ubuntu_installer_v2021.02.a.a12f.tar.gz''' file in the '''Downloads directory'''

||'''Osdag '''installer is now downloaded and saved to the '''Downloads directory '''on my system.

|-
||Only Narration
|| Let us proceed with the installation process.

|-
|| Show '''terminal '''and '''gedit '''text editor opened side-by-side

Press Ctrl + Alt+ T keys to open the Terminal.
|| I have opened the '''terminal '''and '''gedit '''text editor.

I will switch between them as required.

|-
||Only Narration
|| I will now go to the '''Downloads directory''' where I have saved the''' installer '''file.

Users need to choose the '''directory '''where the '''installer '''file is saved.
|-
|| '''Terminal:'''

Type '''cd (space) Downloads''' and press''' Enter'''
|| In the '''terminal''', I will type '''cd (space) Downloads''' and press''' Enter.'''
|-
||Only Narration
|| Here onwards, please remember to press the '''Enter''''''key '''after typing each '''command.'''
|-
|| '''Terminal:'''

Type '''ls '''and press '''Enter'''
|| Type '''ls''' to check whether the '''installer''' file listed in the '''current directory.'''
|-
|| '''Terminal:'''

Point towards '''Osdag_ubuntu_installer_v2021.02.a.a12f.tar.gz''' file
||

The list shows the '''installer''' file.
|-
|| '''gedit '''text editor''':'''

Copy '''tar -xvf Osdag_ubuntu_installer_v2021.02.a.a12f.tar.gz'''
|| To extract the '''installer''' file, copy the first '''command''' from the '''Code file.'''
|-
|| '''Terminal:'''

Paste in the '''Terminal''' and press '''Enter'''
|| Paste it in the '''terminal'''and press '''Enter.'''
|-
||Only Narration
||Now we have to navigate into the extracted '''Osdag installer folder.'''
|-
||'''gedit '''text editor''':'''

Copy '''cd Osdag_ubuntu_installer_v2021.02.a.a12f'''
||Copy the next '''command''' from the '''Code file'''.

|-
||'''Terminal:'''

Paste in the '''Terminal''' and press '''Enter'''
||Paste it in the '''terminal '''and press '''Enter.'''
|-
|| '''Slide:'''

'''Installation Steps'''

|| Installing '''Osdag '''is a two-step process
* First step is to install "'''Miniconda'''
* Second step is to install "'''Osdag'''

|-
|| '''Slide:'''

What is Miniconda?
|| * "'''Conda'''" is a "'''cross-platform package manager'''
* "'''Miniconda'''" is a minimal installer for conda
* "'''Conda'''" installs, runs and updates "the" "'''packages '''"and their "'''dependencies'''

|-
|| Show '''terminal '''and '''gedit '''text editor opened side-by-side
|| Now, let us proceed with the installation.
|-
|| '''gedit '''text editor''':'''

Copy '''bash 1-install-Miniconda3-latest-Linux-x86_64.sh'''
|| For installing '''Miniconda, '''copy the third command from the '''Code file.'''
|-
|| '''Terminal:'''

Paste in the '''Terminal''' and press '''Enter'''
|| Paste it in the '''terminal '''and press '''Enter.'''
|-
|| '''Terminal:'''

Press '''Enter '''several times

Point to '''More''' on the terminal.
|| Press '''Enter''' several times to scroll through the '''Miniconda Licence '''page.
|-
|| '''Terminal:'''

Type '''yes '''and press '''Enter'''
||

Type '''yes''' to approve the '''licence''' '''terms''' and continue.

|-
|| Cursor at the prompt.

Only Narration.
|| '''Miniconda''' will prompt you for the location where it needs to be installed.

By '''default''', it will be installed in the user’s''' home directory.'''

We can optionally specify another location of our choice.

I will go ahead with the '''default '''location.
|-
|| '''Terminal:'''

Press''' Enter'''
|| Press '''Enter '''to confirm and proceed further.
|-
|| '''Terminal: '''

Type '''yes '''and press '''Enter'''
|| Type '''yes''' and press '''Enter''' to initialise '''Miniconda3 '''by running '''conda init.'''
|-
|| Point to the message.
|| We can see a message notifying the successful installation of '''Miniconda.'''
|-
|| Close and reopen the '''Terminal''' by pressing the '''Ctrl, Alt and T '''keys together
|| I will close the terminal and then reopen it by pressing the '''Ctrl, Alt and T '''keys together.

|-
|| Only narration
|| This step is necessary for the '''miniconda '''installation to take effect.
|-
|| Only narration
|| Now we have to again navigate into the extracted '''Osdag installer folder.'''
|-
|| '''Terminal:'''

Type '''cd (space) Downloads''' and press''' Enter'''
|| In the '''terminal''', I will type '''cd (space) Downloads''' and press''' Enter.'''
|-
||'''gedit '''text editor''':'''

Copy '''cd Osdag_ubuntu_installer_v2021.02.a.a12f'''
||

Copy the second '''command''' from the '''Code file'''.

|-
||'''Terminal:'''

Paste in the '''Terminal''' and press '''Enter'''
||

Paste it in the '''terminal '''and press '''Enter.'''
|-
|| Only narration
|| Now let us proceed with the installation of '''Osdag.'''
|-
|| '''gedit '''text editor''':'''

Copy '''bash 2-install-osdag.sh'''

|| For installing '''Osdag''', copy the fourth '''command''' from the '''Code file'''.

|-
|| '''Terminal:'''

Paste in the '''Terminal''' and press '''Enter'''
|| Paste it in the '''terminal '''and press '''Enter.'''
|-
|| '''Terminal:'''

Point to the success message
|| Once the installation is complete, a success message is displayed.

This means we have successfully installed '''Osdag''' in our system.
|-
|| Only narration

|| By default,''' Osdag''' will be installed in the '''home directory.'''

We can confirm this by checking our specified''' installation directory.'''
|-
|| Only narration

|| Let us go to the '''home directory''' using the '''cd command.'''

|-
|| '''Terminal:'''

Type '''cd $HOME'''
|| Type''' cd $HOME'''
|-
|| Only narration
|| Now we are in the '''home directory.'''
|-
|| '''Terminal:'''

Type''' ls''' and press '''Enter'''
|| Type '''ls '''and press '''Enter.'''

|-
|| '''Terminal:'''

Point towards '''miniconda3''' and '''Osdag''' directories
|| We see '''‘miniconda3’''' and '''‘Osdag’''' directories listed under the '''home directory.'''
|-
|| Only narration
|| We can also change the location of '''Osdag.'''

To do so, simply move the '''Osdag''' directory to the preferred location.
|-
|| Only narration
|| Let us now launch '''Osdag''' through the '''Terminal.'''
|-
|| '''Terminal: '''

Type '''cd Osdag'''
|| To enter the '''Osdag directory''', type''' cd Osdag'''
|-
|| '''gedit '''text editor''':'''

Copy '''python osdagMainPage.py'''
||

To start '''Osdag''', copy the last '''command''' from the '''Code file.'''
|-
|| '''Terminal:'''

Paste and press '''Enter'''
||

Paste the '''command '''in the '''terminal '''and press '''Enter.'''
|-
||Only Narration

|| It may take some time to open '''Osdag '''for the very first time.

|-
|| Point towards the '''Osdag''' '''Interface'''
|| Now we can see the '''Osdag''' interface on the screen.
|-
|| Only narration
|| Let us validate the installation by running a '''sample design example.'''
|-
|| '''Osdag:'''

Click on the '''Connection module'''
|| Click on the '''Connection module '''present at the top left side.
|-
|| Click on '''Fin Plate''' image
|| Click on the '''Fin Plate '''image to select the '''module.'''
|-
|| Click on '''Start'''
|| Click on the '''Start button '''below to launch the '''module.'''
|-
|| Only narration
|| The '''module '''might take some time to launch.
|-
|| '''Fin Plate Connection GUI:'''

Click on '''File''' '''Load input'''
|| Go to the '''File menu''' present at the top left corner, and select '''Load input.'''
|-
|| '''Open Design Window:'''

Browse to the '''Code file directory'''
|| I will browse to the '''Code file directory.'''
|-
|| '''Open Design Window:'''

Select the '''FinPlate_sample_design.osi '''file and click on '''Open'''
|| Select '''FinPlate_sample_design.osi, '''and

Click on the '''Open button.'''
|-
|| Point toward the''' Input Dock fields'''
|| We see the input values are populated for our '''sample design example'''.

|-
|| Only narration
|| We are now ready to perform the '''design'''.
|-
|| '''Fin Plate Connection GUI:'''

Click on the '''Design button'''
|| Click on the '''Design button '''at bottom to start.
|-
|| '''Osdag:'''

Point towards the '''CAD window '''and the '''Log messages window'''
|| Osdag will display the '''CAD model''' and print '''log messages.'''
|-
|| Only narration
|| This means that the '''design '''is complete.

This indicates that the installation of '''Osdag '''is successful.
|-
|| Only narration
|| This brings us to the end of this tutorial.

Let us summarise.
|-
|| '''Slide:'''

'''Summary'''

|| In this tutorial, we have

* Downloaded and installed '''Osdag''' on '''Ubuntu''' '''Linux OS'''
* Opened '''Osdag '''through''' Terminal'''
* Verified the installation

|-
|| '''Slide:'''

'''About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project

Please download and watch it
|-
|| '''Slide:'''

'''Spoken Tutorial Workshops'''
|| The Spoken Tutorial Project team conducts workshops and gives certificates.

For more details, please write to us
|-
|| '''Slide:'''

'''Answers for THIS Spoken Tutorial'''
||Please post your timed queries in this forum
|-
|| '''Slide:'''

'''FOSSEE Forum
||For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
|-
|| '''Slide: '''

'''Acknowledgements'''
|| The '''Spoken''''''Tutorial''' project is funded by the '''Ministry of Education''', Government of India
|-
|| '''Slide:'''

'''Thank you'''
|| This is '''Zahran Sajid''', a FOSSEE summer fellow 2022, IIT Bombay signing off

Thanks for joining
|-
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Unconstrained-Optimization-using-FOT/English

2022-02-28T21:24:34Z

Anandajitht:

'''Title of the script''': '''Unconstrained Optimisation using FOT'''

'''Author: Siddharth Agarwal, Anandajith TS'''

'''Keywords: FOSSEE Optimization Toolbox, Integer Unconstrained Optimisation, Unconstrained Optimisation, fminunc, intfminunc.'''
{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide 1

'''Title Slide'''
| Welcome to the spoken tutorial on '''Unconstrained Optimisation using FOT.'''
|-
|
Show Slide 2

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' in '''Scilab'''.
*Solve unconstrained '''optimisation''' problems using '''fot_fminunc and fot_intfminunc functions'''.
|-
|
Show Slide 3

'''System Requirement'''
|
To record this tutorial, I am using

*'''Windows 10''' as the operating system
*'''Scilab 6.1.0'''
*'''FOSSEE Optimization Toolbox''' version '''0.4.1'''

The process demonstrated in this tutorial is identical in '''Linux''' OS also.

Annotations will be added to the tutorial if there are any differences.
|-
|
Show Slide 4

'''Pre-requisites'''

'''https://spoken-tutorial.org'''
|
To follow this tutorial, you should

*Install '''FOSSEE Optimization Toolbox''' version 0.4.1 or above.
*Have basic understanding of '''Scilab''' and '''Optimization theory'''.

If not, for relevant tutorials please visit this site.
|-
|
'''Show slide '''

'''Code Files'''
|
*The files used in this tutorial have been provided in the '''Code files''' link.
*Please download and extract the files.
*Make a copy and then use them while practising.
|-
|
Slide 5

'''What is the Unconstrained Optimisation problem?'''
|A '''function''' is '''nonlinear''' if it has a degree of two or more.

An unconstrained '''optimisation''' problem is a mathematical '''optimization model''' with:

*'''Nonlinear objective function'''
*No constraints
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the '''unconstrained optimization problem''' is as shown.
|-
|
Show Slide 7

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_fminunc'''

In this example, we will learn how to:

*Minimize the given '''function'''.
*Note that the '''objective function''' is '''nonlinear'''.
|-
|

|We will use the '''toolbox''' to solve this example.

Make sure that the '''toolbox''' is already '''installed''' on '''Scilab'''.
|-
| Cursor on the Scilab console.
| Now open the '''Scilab console'''.
|-
| Type '''editor''' >> press '''Enter'''.
|
In the '''Scilab console,''' type '''editor''' and press '''Enter'''.

'''Editor''' window opens.
|-
|Click on '''Open''' button.
|Click on '''Open''' button on the '''toolbar'''.
|-
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Click on the '''Open''' button.
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Then click on the '''Open''' button.
|-
|Point to the file.
|'''opt_fminunc.sce''' file opens in the '''editor'''.
|-
| Show '''opt_fminunc.sce''' in scilab editor.
| Now we will see the '''input arguments''' for '''fot_fminunc'''.
|-
| Highlight '''‘f’'''
|'''f''' is an '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt, fopt, exitflag, output, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Output’'''
|'''Output''' is a structure containing detailed information about the '''optimization'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution.
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Highlight

'''[xopt,fopt,exitflag,output,gradient,hessian]=fot_fminunc(f,x0)'''
| Here we see the '''Scilab''' code to define and solve the example.

Now call the '''fot_fminunc function''' to solve the given problem.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on '''scilab'''.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the '''output'''.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.466D-16,
*'''Output''' as the '''Optimal solution Found'''.
|-
|
Show Slide

'''Integer Nonlinear Programming'''
|
We will now look at '''integer nonlinear programming''' problems.

These are problems where some '''decision variables''' are constrained to be '''integers'''.
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the unconstrained '''integer programming''' problem is as shown.
|-
|
Show Slide

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_intfminunc.'''

In this example, we will learn how to:

*Minimize the given '''function'''.
*Note that the '''objective function''' is '''nonlinear'''.

Some of the '''decision variables''' are '''integers'''.
|-
| Show '''opt_intfminunc.sce''' in '''scilab editor.'''
|
We will use the '''toolbox''' to solve this example.

Open the '''Scilab console'''.

Type '''editor''' on the '''Scilab console''' and press '''Enter'''.

Open '''opt_intfminunc.sce''' in the '''Scilab editor.'''
|-
| Highlight '''‘f’'''
|'''f''' is the '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight '''‘intcon’'''
|'''intcon''' is a '''vector''' of the '''indices''' of the '''integer variables'''.

|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt,''' '''fopt''', '''exitflag, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on scilab.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down menu.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the output.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.341D-19,
*'''Output''' as the '''Optimal solution Found'''.
|-
|
Show Slide

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' of the '''FOSSEE Optimization Toolbox'''.
*Solve unconstrained '''nonlinear programming''' examples in '''Scilab'''.
|-
|
Show Slide

'''Assignment'''
|
As an assignment, please do the following:

*What will be the solution of the following example?
|-
|
Show Slide

'''Assignment'''
|
*The optimal value will be 2547.7231 and
*Optimal solution will be '''x one''' equal to 64.363297and '''x two''' equal to 50.720229.
|-
|
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'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|This is Anandajith TS, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Unconstrained-Optimization-using-FOT/English

2021-12-22T21:24:32Z

Anandajitht:

'''Title of the script''': '''Unconstrained Optimisation using FOT'''

'''Author: Siddharth Agarwal, Anandajith TS'''

'''Keywords: FOSSEE Optimization Toolbox, Integer Unconstrained Optimisation, Unconstrained Optimisation, fminunc, intfminunc.'''
{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide 1

'''Title Slide'''
| Welcome to the spoken tutorial on '''Unconstrained Optimisation using FOT.'''
|-
|
Show Slide 2

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' in '''Scilab'''.
*Solve unconstrained '''optimisation''' problems using '''fot_fminunc and fot_intfminunc functions'''.
|-
|
Show Slide 3

'''System Requirement'''
|
To record this tutorial, I am using

*'''Windows 10''' as the operating system
*'''Scilab 6.1.0'''
*'''FOSSEE Optimization Toolbox''' version '''0.4.1'''

The process demonstrated in this tutorial is identical in '''Linux''' OS also.

Annotations will be added to the tutorial if there are any differences.
|-
|
Show Slide 4

'''Pre-requisites'''

'''https://spoken-tutorial.org'''
|
To follow this tutorial, you should

*Install '''FOSSEE Optimization Toolbox''' version 0.4.1 or above.
*Have basic understanding of '''Scilab''' and '''Optimization theory'''.

If not, for relevant tutorials please visit this site.
|-
|
'''Show slide '''

'''Code Files'''
|
*The files used in this tutorial have been provided in the '''Code files''' link.
*Please download and extract the files.
*Make a copy and then use them while practising.
|-
|
Slide 5

'''What is the Unconstrained Optimisation problem?'''
|A '''function''' is '''nonlinear''' if it has a degree of two or more.

An unconstrained '''optimisation''' problem is a mathematical '''optimization model''' with:

*'''Nonlinear objective function'''
*No constraints
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the '''unconstrained optimization problem''' is as shown.
|-
|
Show Slide 7

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_fminunc'''

In this example, we will learn how to:

*Minimize the given '''function'''.
*Note that the '''objective function''' is '''nonlinear'''.
|-
|

|We will use the '''toolbox''' to solve this example.

Make sure that the '''toolbox''' is already '''installed''' on '''Scilab'''.
|-
| Cursor on the Scilab console.
| Now open the '''Scilab console'''.
|-
| Type '''editor''' >> press '''Enter'''.
|
In the '''Scilab console,''' type '''editor''' and press '''Enter'''.

'''Editor''' window opens.
|-
|Click on '''Open''' button.
|Click on '''Open''' button on the '''toolbar'''.
|-
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Click on the '''Open''' button.
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Then click on the '''Open''' button.
|-
|Point to the file.
|'''opt_fminunc.sce''' file opens in the '''editor'''.
|-
| Show '''opt_fminunc.sce''' in scilab editor.
| Now we will see the '''input arguments''' for '''fot_fminunc'''.
|-
| Highlight '''‘f’'''
|'''f''' is an '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt, fopt, exitflag, output, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Output’'''
|'''Output''' is a structure containing detailed information about the '''optimization'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution.
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Highlight

'''[xopt,fopt,exitflag,output,gradient,hessian]=fot_fminunc(f,x0)'''
| Here we see the '''Scilab''' code to define and solve the example.

Now call the '''fot_fminunc function''' to solve the given problem.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on '''scilab'''.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the '''output'''.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.466D-16,
*'''Output''' as the '''Optimal solution Found'''.
|-
|
Show Slide

'''Integer Nonlinear Programming'''
|
We will now look at '''integer nonlinear programming''' problems.

These are problems where some '''decision variables''' are constrained to be '''integers'''.
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the unconstrained '''integer programming''' problem is as shown.
|-
|
Show Slide

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_intfminunc.'''

In this example, we will learn how to:

*Minimize the given '''function'''.
*Note that the '''objective function''' is '''nonlinear'''.

Some of the '''decision variables''' are '''integers'''.
|-
| Show '''opt_intfminunc.sce''' in '''scilab editor.'''
|
We will use the '''toolbox''' to solve this example.

Open the '''Scilab console'''.

Type '''editor''' on the '''Scilab console''' and press '''Enter'''.

Open '''opt_intfminunc.sce''' in the '''Scilab editor.'''
|-
| Highlight '''‘f’'''
|'''f''' is the '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight '''‘intcon’'''
|'''intcon''' is a '''vector''' of the '''indices''' of the '''integer variables'''.

|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt,''' '''fopt''', '''exitflag, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on scilab.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down menu.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the output.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.341D-19,
*'''Output''' as the '''Optimal solution Found'''.
|-
|
Show Slide

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' of the '''FOSSEE Optimization Toolbox'''.
*Solve unconstrained '''nonlinear programming''' examples in '''Scilab'''.
|-
|
Show Slide

'''Assignment'''
|
As an assignment, please do the following:

*What will be the solution if we include the following constraint in the previous example?
|-
|
Show Slide

'''Assignment'''
|
*The optimal value will be 2547.7231 and
*Optimal solution will be '''x one''' equal to 64.363297and '''x two''' equal to 50.720229.
|-
|
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'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|This is Anandajith TS, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Unconstrained-Optimization-using-FOT/English

2021-12-22T21:10:47Z

Anandajitht:

'''Title of the script''': '''Unconstrained Optimisation using FOT'''

'''Author: Siddharth Agarwal, Anandajith TS'''

'''Keywords: FOSSEE Optimization Toolbox, Integer Unconstrained Optimisation, Unconstrained Optimisation, fminunc, intfminunc.'''
{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide 1

'''Title Slide'''
| Welcome to the spoken tutorial on '''Unconstrained Optimisation using FOT.'''
|-
|
Show Slide 2

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' in '''Scilab'''.
*Solve unconstrained '''optimisation''' problems using '''fot_fminunc and fot_intfminunc functions'''.
|-
|
Show Slide 3

'''System Requirements'''
|
To record this tutorial, I am using

*'''Windows 10''' as the operating system
*'''Scilab 6.1.0'''
*'''FOSSEE Optimization Toolbox''' version '''0.4.1'''

The process demonstrated in this tutorial is identical in '''Linux''' OS also.

Annotations will be added to the tutorial if there are any differences.
|-
|
Show Slide 4

'''Pre-requisites'''

'''https://spoken-tutorial.org'''
|
To follow this tutorial, you should

*Install '''FOSSEE Optimization Toolbox''' version 0.4.1 or above.
*Have basic understanding of '''Scilab''' and '''optimization theory'''.

If not, for relevant tutorials please visit this site.
|-
|
'''Show slide '''

'''Code Files'''
|
*The files used in this tutorial are have been provided in the '''Code files''' link.
*Please download and extract the files.
*Make a copy and then use them while practising.
|-
|
Slide 5

'''What is the Unconstrained Optimisation problem?'''
|A '''function''' is '''nonlinear''' if it has a degree of two or more.

An unconstrained '''optimisation''' problem is a mathematical '''optimization model''' with:

*'''Nonlinear objective function'''
*No constraints
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the '''unconstrained optimization problem''' is as shown.
|-
|
Show Slide 7

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_fminunc'''

In this example, we will learn how to:

*Minimize the given '''function'''.
*Note that the '''objective function''' is '''nonlinear'''.
|-
|

|We will use the '''toolbox''' to solve this example.

Make sure that the '''toolbox''' is already '''installed''' on '''Scilab'''.
|-
| Cursor on the Scilab console.
| Now open the '''Scilab console'''.
|-
| Type '''editor''' >> press '''Enter'''.
|
In the '''Scilab console,''' type '''editor''' and press '''Enter'''.

'''Editor''' window opens.
|-
|Click on '''Open''' button.
|Click on '''Open''' button on the '''toolbar'''.
|-
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Click the '''Open''' button.
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Then click the '''Open''' button.
|-
|Point to the file.
|'''opt_fminunc.sce''' file opens in the '''editor'''.
|-
| Show '''opt_fminunc.sce''' in scilab editor.
| Now we will see the '''input arguments''' for '''fot_fminunc'''.
|-
| Highlight '''‘f’'''
|'''f''' is an '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt, fopt, exitflag, output, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Output’'''
|'''Output''' is structure containing detailed information about the '''optimization'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution.
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Highlight

'''[xopt,fopt,exitflag,output,gradient,hessian]=fot_fminunc(f,x0)'''
| Here we see the '''Scilab''' code to define and solve the example.

We call the '''fot_fminunc function''' to solve the given problem.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on '''scilab'''.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the '''output'''.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.466D-16,
*'''Output''' as the '''Optimal solution Found'''.
|-
|
Show Slide

'''Integer Nonlinear Programming'''
|
We will now look at '''integer nonlinear programming''' problems.

These are problems where some '''decision variables''' are constrained to be '''integers'''.
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the unconstrained '''integer programming''' problem is as shown.
|-
|
Show Slide

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_intfminunc.'''

In this example, we will learn how to:

*Minimize the given '''function'''.
*Note that the '''objective function''' is '''nonlinear.'''

Some of the '''decision variables''' are '''integers'''.
|-
| Show '''opt_intfminunc.sce''' in '''scilab editor.'''
|
We will use the '''toolbox''' to solve this example.

Open the '''Scilab console'''.

Type '''editor''' on the '''Scilab console''' and press '''Enter'''.

Open '''opt_intfminunc.sce''' in the '''Scilab editor.'''
|-
| Highlight '''‘f’'''
|'''f''' is the '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight '''‘intcon’'''
|'''intcon''' is a '''vector''' of the '''indices''' of the '''integer variables'''.

|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt,''' '''fopt''', '''exitflag, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on scilab.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the output.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.341D-19,
*'''Output''' as the '''Optimal solution Found'''.
|-
|
Show Slide

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' of the '''FOSSEE Optimization Toolbox'''.
*Solve unconstrained '''nonlinear programming''' examples in '''Scilab'''.
|-
|
Show Slide

'''Assignment'''
|
As an assignment, please do the following:

*What will be the solution if we include the following constraint in the previous example?
|-
|
Show Slide

'''Assignment'''
|
*The optimal value will be 2547.7231 and
*Optimal solution will be '''x one''' equal to 64.363297and '''x two''' equal to 50.720229.
|-
|
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'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|This is Anandajith TS, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Unconstrained-Optimization-using-FOT/English

2021-12-22T19:47:59Z

Anandajitht:

'''Title of the script''': '''Unconstrained Optimisation using FOT'''

'''Author: Siddharth Agarwal, Anandajith TS'''

'''Keywords: FOSSEE Optimization Toolbox, Integer Unconstrained Optimisation, Unconstrained Optimisation, fminunc, intfminunc.'''
{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide 1

'''Title Slide'''
| Welcome to the spoken tutorial on '''Unconstrained Optimisation using FOT.'''
|-
|
Show Slide 2

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' in '''Scilab'''
*Solve unconstrained '''optimisation''' problems using '''fot_fminunc and fot_intfminunc functions'''
|-
|
Show Slide 3

'''System Requirements'''
|
To record this tutorial, I am using

*'''Windows 10''' as the operating system
*'''Scilab 6.1.0'''
*'''FOSSEE Optimization Toolbox''' version '''0.4.1'''

The process demonstrated in this tutorial is identical in '''Linux''' OS also.

Annotations will be added to the tutorial if there are any differences.
|-
|
Show Slide 4

'''Pre-requisites'''

'''https://spoken-tutorial.org'''
|
To follow this tutorial, you should

*Install '''FOSSEE Optimization Toolbox''' version 0.4.1 or above
*Have basic understanding of '''Scilab''' and '''optimization theory'''

If not, for relevant tutorials please visit this site.
|-
|
'''Show slide '''

'''Code Files'''
|
*The files used in this tutorial are have been provided in the '''Code files''' link
*Please download and extract the files
*Make a copy and then use them while practising
|-
|
Slide 5

'''What is the Unconstrained Optimisation problem?'''
|A '''function''' is '''nonlinear''' if it has a degree of two or more.

An unconstrained '''optimisation''' problem is a mathematical '''optimization model''' with:

*'''Nonlinear objective function'''
*No constraints
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the '''unconstrained optimization problem''' is as shown.
|-
|
Show Slide 7

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_fminunc'''

In this example, we will learn how to:

*Minimize the given '''function'''
*Note that the '''objective function''' is '''nonlinear'''
|-
|

|We will use the '''toolbox''' to solve this example.

Make sure that the '''toolbox''' is already '''installed''' on '''Scilab'''.
|-
| Cursor on the Scilab console.
| Now open the '''Scilab console'''.
|-
| Type '''editor''' >> press '''Enter'''.
|
In the '''Scilab console,''' type '''editor''' and press '''Enter'''.

'''Editor''' window opens.
|-
|Click on '''Open''' button.
|Click on '''Open''' button on the '''toolbar'''.
|-
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Click the '''Open''' button.
|Go to the '''Downloads''' folder.

Locate the file '''opt_fminunc.sce'''.

Then click the '''Open''' button.
|-
|Point to the file.
|'''opt_fminunc.sce''' file opens in the '''editor'''.
|-
| Show '''opt_fminunc.sce''' in scilab editor.
| Now we will see the '''input arguments''' for '''fot_fminunc'''.
|-
| Highlight '''‘f’'''
|'''f''' is an '''objective function'''
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt, fopt, exitflag, output, gradient, hessian'''.
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Output’'''
|'''Output''' is structure containing detailed information about the '''optimization'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution.
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Highlight

'''[xopt,fopt,exitflag,output,gradient,hessian]=fot_fminunc(f,x0)'''
| Here we see the '''Scilab''' code to define and solve the example.

We call the '''fot_fminunc function''' to solve the given problem.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on '''scilab'''.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the '''output'''.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.466D-16,
*'''Output''' as the '''Optimal solution Found'''
|-
|
Show Slide

'''Integer Nonlinear Programming'''
|
We will now look at '''integer nonlinear programming''' problems.

These are problems where some '''decision variables''' are constrained to be '''integers'''.
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A general form of the unconstrained '''integer programming''' problem is as shown.
|-
|
Show Slide

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_intfminunc.'''

In this example, we will learn how to:

*Minimize the given '''function'''
*Note that the '''objective function''' is '''nonlinear.'''

Some of the '''decision variables''' are '''integers'''.
|-
| Show '''opt_intfminunc.sce''' in '''scilab editor.'''
|
We will use the '''toolbox''' to solve this example.

Open the '''Scilab console'''.

Type '''editor''' on the '''Scilab console''' and press '''Enter'''.

Open '''opt_intfminunc.sce''' in the '''Scilab editor.'''
|-
| Highlight '''‘f’'''
|'''f''' is the '''objective function'''.
|-
| Highlight '''‘x0’'''
|'''x0''' is a '''vector''' containing the starting values of the '''decision variables'''.
|-
| Highlight '''‘intcon’'''
|'''intcon''' is a '''vector''' of the '''indices''' of the '''integer variables'''.

|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, gradient, hessian’'''
|
Now we will see the '''output arguments'''.

'''Output arguments''' are '''xopt,''' '''fopt''', '''exitflag, gradient, hessian'''
|-
| Highlight '''‘xopt’'''
|'''xopt''' is the optimal value of '''x'''.
|-
| Highlight '''‘fopt’'''
|'''fopt''' is the optimal '''objective function''' value.
|-
| Highlight '''‘exitflag’'''
|'''exitflag''' is the status of '''execution'''.
|-
| Highlight '''‘Gradient’'''
|'''Gradient''' is a '''vector''' containing the '''objective's gradient''' of the solution
|-
| Highlight '''‘Hessian’'''
|'''Hessian''' is a '''matrix''' containing the '''Lagrangian's hessian''' of the solution.
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on scilab.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute menu'''.

Click on '''File with Echo''' from the drop-down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab console''' to see the output.

We see that it prints the

*'''xopt''' value as 1,1,
*'''fopt''' value as 1.341D-19,
*'''Output''' as the '''Optimal solution Found'''
|-
|
Show Slide

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

*Use '''fot_fminunc''' and '''fot_intfminunc functions''' of the '''FOSSEE Optimization Toolbox'''.
*Solve unconstrained '''nonlinear programming''' examples in '''Scilab'''.
|-
|
Show Slide

'''Assignment'''
|
As an assignment, please do the following:

*What will be the solution if we include the following constraint in the previous example?
|-
|
Show Slide

'''Assignment'''
|
*The optimal value will be 2547.7231 and
*Optimal solution will be '''x one''' equal to 64.363297and '''x two''' equal to 50.720229
|-
|
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'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|This is Anandajith TS, FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Installation-of-FOSSEE-Optimization-Toolbox/English

2021-12-20T19:14:46Z

Anandajitht:

'''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'''
{|border=1
! '''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 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/ ''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 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 '''scan'''ning 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 '''restart'''ed '''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.
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Installation-of-FOSSEE-Optimization-Toolbox/English

2021-09-13T21:11:44Z

Anandajitht: Created page with "'''Title of script''': Installation of '''FOSSEE Optimization Toolbox''' '''Author: Harpreet Singh, Georgey John, Rupak Rokade and Anandajith T S''' '''Keywords:Scilab, FOSS..."

'''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'''
{|border=1
! '''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:

<ul>
<li><blockquote>'''Install''' the '''FOSSEE Optimization''' '''Toolbox'''.</blockquote></li>
<li><blockquote>'''Execute''' a few '''examples''' using the '''toolbox'''.</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Ubuntu 18.04''' as the operating system and</blockquote></li>
<li><blockquote>'''Scilab 6.1.0'''</blockquote></li></ul>
|-
|
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 :

<ul>
<li><blockquote>basic knowledge of '''Scilab''' and '''Optimization Theory'''</blockquote></li></ul>

For '''Scilab''', please refer to the '''Scilab''' tutorials available on the '''Spoken Tutorial''' website.
|-
|
Show Slide:

'''What is FOSSEE Optimization Toolbox?'''
|
<ul>
<li><blockquote>'''FOT''' is a '''toolbox''' in '''Scilab.'''</blockquote></li>
<li><blockquote>It solves optimization problems using '''functions''' like '''linprog''', '''fmincon''' and many others'''.'''</blockquote></li>
<li><blockquote>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.</blockquote></li></ul>
|-
|
In the '''Scilab''' console, type '''atomsGui''' >> press '''Enter'''

*
|
There are several ways to '''install''' the '''toolbox. '''

I will demonstrate one of the ways.

Open '''Scilab'''.

In the '''Scilab console''' type '''atomsGui''' and press '''Enter.'''

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.

This will show the '''toolboxes''' available in the '''Optimization''' category.
|-
| Click once on the '''FOSSEE Optimization Toolbox'''
|
Click once on the '''FOSSEE Optimization Toolbox.'''

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

Scroll up until you see the '''Changelog statement'''.

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/ ''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/ ''https://atoms.scilab.org/'']

And press '''Enter.'''

This will open the '''atoms web page.'''
|-
| In the '''search bar >>''' type '''fot''' >> press enter
|
In the '''search bar''' type, '''fot''' and press '''Enter.'''

You can see '''FOSSEE Optimization Toolbox''' in the search result. Click on it.

Notice that the version shown is '''0.4''' which is the latest version.

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 the '''File''' menu.

Then click on '''Update List of Packages'''
|-
|

|
This will open a pop up window showing a '''progress bar'''.

It is updating the list of '''packages'''.

After the popup 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 '''scan'''ning the '''repository'''.
|-
| Click on the '''Install''' button
|
If the '''toolbox''' version shown in the '''Module Manager- ATOMS''' window is the latest one, we can '''install''' it.

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'''
|
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.'''

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 '''

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

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:

<ul>
<li><blockquote>'''Install''' the '''FOSSEE Optimization Toolbox'''.</blockquote></li>
<li><blockquote>'''Execute''' examples from the '''Help menu''' in the '''toolbox'''.</blockquote></li></ul>
|-
| 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.
|}

Scilab---FOSSEE-Optimisation-Toolbox/C2/Unconstrained-Optimization-using-FOT/English

2021-09-09T12:38:58Z

Anandajitht: Created page with "'''Title of the script''': '''Unconstrained Optimisation using FOT''' '''Author: Siddharth Agarwal, Anandajith TS''' '''Keywords: FOSSEE Optimization Toolbox, Integer Uncons..."

'''Title of the script''': '''Unconstrained Optimisation using FOT'''

'''Author: Siddharth Agarwal, Anandajith TS'''

'''Keywords: FOSSEE Optimization Toolbox, Integer Unconstrained Optimisation, Unconstrained Optimisation, fminunc, intfminunc.'''
{|border=1
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide 1

'''Title Slide'''
| Welcome to the spoken tutorial on '''Unconstrained Optimisation using FOT.'''
|-
|
Show Slide 2

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Use '''fot_fminunc''' and '''fot_intfminunc''' functions in '''Scilab'''</blockquote></li>
<li><blockquote>Solve '''unconstrained optimisation''' problems using '''fot_fminunc and fot_intfminunc functions'''</blockquote></li></ul>
|-
|
Show Slide 3

'''System Requirements'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Windows 10''' as the operating system</blockquote></li>
<li><blockquote>'''Scilab 6.1.0'''</blockquote></li>
<li><blockquote>'''FOSSEE Optimization Toolbox''' version '''0.4.1'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Linux''' OS also
|-
| '''Only narration'''
| Annotations will be added to the tutorial if there are any differences.
|-
|
Show Slide 4

'''Pre-requisites'''

'''https://spoken-tutorial.org'''
|
To follow this tutorial, you should

<ul>
<li><blockquote>Install '''FOSSEE Optimization Toolbox''' version 0.4.1 or above</blockquote></li>
<li><blockquote>Have basic understanding of Scilab and optimization theory</blockquote></li></ul>

If not, for relevant tutorials please visit this site.
|-
|
'''Show slide '''

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial <s>are</s> have been provided in the '''Code files''' link</blockquote></li>
<li><blockquote>Please download and extract the files</blockquote></li>
<li><blockquote>Make a copy and then use them while practising</blockquote></li></ul>
|-
|
Slide 5

'''What is the Unconstrained Optimisation problem?'''
|
A function is nonlinear if it has a degree of two or more

'''An Unconstrained Optimisation Problem''' is a mathematical optimization model with:

<ul>
<li><blockquote>'''Nonlinear''' objective function</blockquote></li>
<li><blockquote>'''No constraints'''</blockquote></li></ul>
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A '''general form''' of the '''unconstrained optimization problem''' is as shown.
|-
|
Show Slide 7

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_fminunc'''

In this example, we will learn how to:

<ul>
<li><blockquote>Minimize the given function</blockquote></li>
<li><blockquote>Note that the '''objective function''' is '''nonlinear'''</blockquote></li></ul>
|-
|

|
We will use the toolbox to solve this example.

Make sure that the toolbox is already installed on Scilab.
|-
| Cursor on the Scilab console.
| Now open the '''Scilab console'''
|-
| Type '''editor''' >> press '''Enter'''.
|
In the '''Scilab console''' type '''editor''' and press '''Enter'''

'''Editor''' window opens
|-
|
Click on Open button.

Go to the Downloads folder.

Locate the file '''opt_fminunc.sce'''.

Click the '''Open''' button.

Point to the file.
|
Click on '''Open''' button on the toolbar.

Go to the Downloads folder

Locate the file '''opt_fminunc.sce'''.

Then click the '''Open''' button.

'''opt_fminunc.sce''' file opens in the '''editor'''
|-
| Show '''opt_fminunc.sce''' in scilab editor.
| Now we will see the input arguments for '''fot_fminunc'''
|-
| Highlight '''‘f’'''
|
<ul>
<li><blockquote>'''f''' is an '''objective function'''</blockquote></li></ul>
|-
| Highlight '''‘x0’'''
|
<ul>
<li><blockquote>'''x0''' is a vector containing the starting values of the decision variables.</blockquote></li></ul>
|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian’'''
|
Now we will see the output arguments.

Output arguments are '''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian'''
|-
| Highlight '''‘xopt’'''
|
<ul>
<li><blockquote>'''xopt''' is the optimal value of '''x'''.</blockquote></li></ul>
|-
| Highlight '''‘fopt’'''
|
<ul>
<li><blockquote>'''fopt''' is the optimal objective function value'''.'''</blockquote></li></ul>
|-
| Highlight '''‘exitflag’'''
|
<ul>
<li><blockquote>'''exitflag''' is the status of execution</blockquote></li></ul>
|-
| Highlight '''‘Output’'''
|
<ul>
<li><blockquote>'''Output''' is a '''structure''' containing detailed information about the optimization.</blockquote></li></ul>
|-
| Highlight '''‘Gradient’'''
|
<blockquote>'''Gradient''' is a '''vector''' containing the '''objective's''' '''gradient''' of the solution
</blockquote>
|-
| Highlight '''‘Hessian’'''
|
<blockquote>'''Hessian''' is a '''matrix''' containing the '''lagrangian's hessian''' of the solution
</blockquote>
|-
|
Highlight

'''[xopt,fopt,exitflag,output,gradient,hessian]=fot_fminunc(f,x0)'''
|
<ul>
<li><blockquote>Here we see the '''scilab''' code to define and solve the example.</blockquote></li>
<li><blockquote>We call the '''fot_fminunc function''' to solve the given '''problem'''.</blockquote></li>
<li></li></ul>
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on '''scilab'''.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute''' menu.

Click on '''File with Echo''' from the drop down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the Scilab '''console''' to see the output.

We see that it prints the

<ul>
<li><blockquote>'''xopt''' value as 1,1,</blockquote></li>
<li><blockquote>'''fopt''' value as 1.466D-16,</blockquote></li>
<li><blockquote>'''Output as the Optimal solution Found'''</blockquote></li></ul>
|-
|
Show Slide

'''Integer Nonlinear Programming'''
|
We will now look at '''integer nonlinear programming''' problems.

These are problems where some decision variables are constrained to be integers.
|-
|
Show Slide 6

'''Mathematical Formulation'''
| A '''general form''' of the '''unconstrained''' '''integer programming problem''' is as shown.
|-
|
Show Slide

'''Example'''
|
We will now solve this example to illustrate the use of '''fot_intfminunc.'''

In this example, we will <s>demonstrate</s> learn how to:

<ul>
<li><blockquote>Minimize the given function</blockquote></li>
<li><blockquote>Note that the '''objective function''' is '''nonlinear.'''</blockquote></li></ul>

Some of the '''decision variables''' are '''integers'''.
|-
| Show '''opt_intfminunc.sce''' in '''scilab editor.'''
|
We will use the toolbox to solve this example.

Open the '''Scilab console'''.

Type editor on the Scilab console and Press enter.

Open '''opt_intfminunc.sce''' in the '''Scilab editor.'''
|-
| Highlight '''‘f’'''
|
<ul>
<li><blockquote>'''f''' is the '''objective function'''</blockquote></li>
<li></li></ul>
|-
| Highlight '''‘x0’'''
|
<ul>
<li><blockquote>'''x0''' is a vector containing the starting values of the decision variables</blockquote></li></ul>
|-
| Highlight '''‘intcon’'''
|
<blockquote>'''intcon''' is a '''vector''' of the '''indices''' of the integer variables
</blockquote>
|-
| Highlight ‘'''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian’'''
|
Now we will see the output arguments.

<ul>
<li><blockquote>Output arguments are '''xopt,''' '''fopt''', '''exitflag, output, gradient, hessian'''</blockquote></li></ul>
|-
| Highlight '''‘xopt’'''
|
<ul>
<li><blockquote>'''xopt''' is the optimal value of '''x'''.</blockquote></li></ul>
|-
| Highlight '''‘fopt’'''
|
<ul>
<li><blockquote>'''fopt''' is the optimal objective function value'''.'''</blockquote></li></ul>
|-
| Highlight '''‘exitflag’'''
|
<ul>
<li><blockquote>'''exitflag''' is the status of execution</blockquote></li></ul>
|-
| Highlight '''‘Gradient’'''
|
<blockquote>'''Gradient''' is a '''vector''' containing the '''objective's''' '''gradient''' of the solution
</blockquote>
|-
| Highlight '''‘Hessian’'''
|
<blockquote>'''Hessian''' is a '''matrix''' containing the '''lagrangian's hessian''' of the solution
</blockquote>
|-
|
Press '''CTRL + s'''

Click on '''execute button''' on scilab.
|
Save the file by pressing '''Control''' and '''S''' keys simultaneously.

To '''run''' the file, click on the '''Execute''' menu.

Click on '''File with Echo''' from the drop down.
|-
| Change the window to '''Scilab console.'''
|
Switch to the '''Scilab''' '''console''' to see the output.

We see that it prints the

<ul>
<li><blockquote>'''xopt''' value as 1,1,</blockquote></li>
<li><blockquote>'''fopt''' value as 1.341D-19,</blockquote></li>
<li><blockquote>'''Output as the Optimal solution Found'''</blockquote></li></ul>
|-
|
Show Slide

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Use '''fot_fminunc''' and '''fot_intfminunc''' functions of the '''FOSSEE Optimization Toolbox'''.</blockquote></li>
<li><blockquote>Solve unconstrained nonlinear programming examples in '''Scilab'''.</blockquote></li></ul>
|-
|
Show Slide

'''Assignment'''
|
As an assignment, please do the following:

<ul>
<li><blockquote>What will be the solution if we include</blockquote></li></ul>

<blockquote>the following constraint in the previous

example:
</blockquote>
|-
|
Show Slide

'''Assignment'''
|
<ul>
<li><blockquote>The optimal value will be 2547.7231 and</blockquote></li>
<li><blockquote>Optimal solution will be '''x one''' equal to 64.363297and '''x two''' equal to 50.720229</blockquote></li></ul>
|-
|
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'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|
<ul>
<li><blockquote>This is Anandajith TS, FOSSEE intern 2021, IIT Bombay signing off.</blockquote></li></ul>

<ul>
<li><blockquote>Thanks for joining</blockquote></li></ul>
|}

GUI-in-Scilab/C2/Creating-a-basic-GUI-using-Scilab/English

2021-09-08T21:15:20Z

Anandajitht:

'''Title of the script:''' Creating a basic '''GUI''' using Scilab

'''Author: Rashmi Patankar, Shwethaa R'''

{| border
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Welcome to the Spoken Tutorial on “Creating a basic '''GUI''' using Scilab”.
|-
|
Show Slide:

'''Learning objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>About '''Graphical User Interface(GUI)''' and its benefits.</blockquote></li></ul>

<ul>
<li><blockquote>Create a '''pushbutton.'''</blockquote></li>
<li><blockquote>Add a '''callback function''' and</blockquote></li></ul>

<ul>
<li><blockquote>Create a basic '''GUI''' using '''Scilab.'''</blockquote></li></ul>
|-
|
Show Slide:

'''System requirement'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Windows 10''' '''OS''' and</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0'''</blockquote></li></ul>

The process demonstrated in this tutorial is similar in Linux OS.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab'''.</blockquote></li></ul>

<ul>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

Code Files
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

What is a '''Graphical User Interface'''?
|
The '''Graphical User Interface(GUI)''' is:

<ul>
<li><blockquote>A graphical display that allows the user to do interactive tasks using objects.</blockquote></li>
<li><blockquote>Users can create and arrange objects in a graphical window.</blockquote></li></ul>
|-
|
Show Slide:

What is a '''Graphical User Interface'''?
|
<ul>
<li><blockquote>The object style includes '''edit, slider,''' '''pushbutton,''' etc.</blockquote></li>
<li><blockquote>We use their '''callbacks''' to make them interactive.</blockquote></li>
<li><blockquote>'''GUI'''s can also create and display data in a tabular form or as a plot.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a pushbutton?'''
| A '''pushbutton''' is a rectangular button used to run a '''callback.'''
|-
|
Show Slide:

'''What is a callback?'''
|
A '''callback''' is a '''function''' that executes a set of '''commands.'''

This happens in response to a predefined user action.

For example,

<ul>
<li><blockquote>When the '''pushbutton''' is pressed, the code written in the '''callback''' is executed.</blockquote></li>
<li><blockquote>As a result, the '''pushbutton''' becomes interactive.</blockquote></li></ul>
|-
|
On the '''Scilab console''',

type '''editor''' and press '''Enter.'''
|
Open the '''Scilab console'''.

Type '''editor''' and press '''Enter.'''
|-
|
On '''Scinotes Window,'''

highlight '''Scinotes''' on title bar.

Click on '''File'''>>'''Open.'''
|
It opens the '''Scinotes''' window.

Click on '''File''' on the '''menubar''' and then on '''Open.'''
|-
|
On '''Open Window,'''

go to '''Downloads''' folder >> Click on '''basicgui.sce''' file >> Click '''Open.'''

|
Go to the '''Downloads''' folder.

Locate the file '''basicgui.sce''' and click on it.

Click on the '''Open''' button at the bottom.
|-
|
On '''Scinotes''' Window,

hover cursor over '''basicgui.sce''' in the title bar.
|
It opens the file '''basicgui.sce''' in '''Scinotes''' window.

Now we’ll look at the code.
|-
|
Cursor on '''SciNotes Window, '''

highlight '''figure().'''
|
Let's start by creating a '''graphic window.'''

The '''graphic window''' is a window on which we place the objects to create a '''GUI'''.

For creating that''',''' the '''figure function''' is used.
|-
| Cursor on '''SciNotes Window,''' highlight the word '''f.'''
|
'''‘f’''' is the handle of the '''graphic window.'''

It is used to change the properties of the '''graphic window''' after it is created.
|-
|
Cursor on '''Scinotes Window,'''

highlight the line with '''f.visible.'''
|
We then use handle '''‘f'''' to set the '''visible''' property of a '''graphic window''' to '''“ON”.'''

Hence, the '''pushbutton''' becomes visible on a '''graphic window''' after it is created.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''uicontrol.'''
|
The '''uicontrol function''' is used to create a '''pushbutton''' in a '''graphic window'''.

It sets the properties of a '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''h1.'''
|
'''‘h1’''' is the handle of the '''pushbutton.'''

The handle is used to change the properties of a '''pushbutton''' after it is created.

It is also used while writing a '''callback function'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''f''' inside '''uicontrol''' parentheses.
|
Notice that ‘'''f’''' is passed as a first '''argument''' within the '''uicontrol function'''.

So the '''pushbutton''' we make will appear in the '''graphic window''' whose handle is ''''f''''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''style''' and '''pushbutton.'''
| The object '''style''' is set to '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''Position''' and numbers inside '''square brackets'''.
| '''Position''' and size of a '''pushbutton''' is defined within '''square brackets'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''250.'''
| '''250 units''' is the margin from the left side of the window.
|-
|
Cursor on '''Scinotes Window, '''

highlight number '''200.'''
| '''200 units''' is the margin from the top side of the window.
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''100.'''
| '''100 units''' is the width of the '''pushbutton.'''
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''50.'''
| '''50 units''' is the height of the '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''string''' and '''Print.'''
|
The '''string''' denotes the text that appears on top of a '''pushbutton.'''

As we can see, it is set to '''Print'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''callback''' and '''callback_print(h1).'''
| Let us set the '''callback''' property to call the '''function callback_print(h1).'''
|-
|
Cursor on '''Scinotes Window, '''

hover over '''style, position, string''' and '''callback.'''
|
Notice the '''arguments style, position, string''' and '''callback'''.

They are basically the '''property''' names.
|-
|
Cursor on '''Scinotes Window,'''

hover cursor over '''pushbutton, square bracket, Print''' and '''callback_print(h1)'''.
|
Notice the '''arguments - pushbutton, square bracket, Print''' and '''callback_print(h1).'''

They represent the respective '''property''' values.
|-
|
Cursor on '''Scinotes Window,'''

highlight the three dots.

Highlight the lines inside '''uicontrol''' parentheses.
|
There are three dots after ''''f'''' and '''property''' values.

They are used to split the multiple '''arguments''' onto separate lines.

The '''arguments''' within the '''parenthesis'''

can also be written on a single line.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''callback_print(h1)''' function definition.

highlight '''h1''' within parentheses
|
Let us look at the definition of '''callback_print(h1) function.'''

Notice that we have passed '''h1''' as an '''argument''' to this '''function'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the line disp'''(“Hello World”).'''
|
You can see that this '''function''' contains only one '''command.'''

This will display the message “'''Hello World”''' in the '''Scilab''' '''console.'''

The message will be displayed only after we press the '''pushbutton'''.
|-
| Press '''Ctrl+S''' simultaneously.
| Save the file by pressing '''Control''' and ‘'''S'''’ keys simultaneously.
|-
|
In '''Scinotes Window,'''

click on '''Execute''' menu, '''File with echo.'''
|
To '''run''' the file, click on the '''Execute menu''' first.

Then click on '''File with echo''' from the drop-down menu.
|-
|
In '''Graphic Window number 0,'''

highlight the '''Graphic Window number 0''' on the title bar.

Hover cursor over '''Print''' '''pushbutton.'''

click on '''Print.'''
|
A window named '''Graphic Window number 0''' opens.

A '''pushbutton''' named '''Print''' appears'''.'''

Click on '''Print.'''
|-
|
Switch to '''Scilab Console.'''

highlight the message “'''Hello World'''” on '''Scilab console.'''
|
Switch to the '''Scilab console''' to view the output.

The '''console''' shows the message “'''Hello World”'''.

You can see that we got the desired result when we pressed the '''pushbutton'''.
|-
|

| This brings us to the end of this tutorial'''.''' Let us summarize.
|-
|
Show Slide:

'''Summary'''
|
In this tutorial, we have learnt:

<ul>
<li><blockquote>About a '''Graphical User Interface(GUI)''' and its benefits.</blockquote></li>
<li><blockquote>Created a '''pushbutton.'''</blockquote></li>
<li><blockquote>Added a '''callback function.'''</blockquote></li>
<li><blockquote>Created a basic '''GUI''' using '''Scilab.'''</blockquote></li></ul>
|-
|
Show Slide:

Assignment
|
As an assignment, please do the following.

Add one more '''pushbutton''' to the current '''GUI''' as described below,

<ol style="list-style-type: decimal;">
<li><blockquote>Size, Height: '''200 units''' Width: '''100 units'''.</blockquote></li>
<li><blockquote>Position: Align it below the '''Print''' '''pushbutton''' with a gap of '''20 units.'''</blockquote></li></ol>
|-
|
Show Slide:

Assignment
|
<ol style="list-style-type: decimal;">
<li><blockquote>Add a '''String''' named ''''Press here'''' for the '''pushbutton'''.</blockquote></li>
<li><blockquote>Add a '''callback function''' to display the message ''''Good day!'''' on the '''Scilab console'''.</blockquote></li></ol>

<blockquote>Hint: The name of the '''function''' must be different.
</blockquote>
|-
|
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'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

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:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education,''' '''Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
The script has been created by '''FOSSEE Team and FOSSEE intern Shwethaa'''.

The video for this tutorial was created by me '''Anandajith''', I am a '''FOSSEE''' intern signing off.

Thanks for watching.
|}

Scilab/C4/Super-Blocks-in-Xcos/English

2021-09-07T21:26:18Z

Anandajitht:

'''Title of script''': Super Blocks in Xcos

'''Author: Rupak Rokade and Anandajith'''

'''Keywords: Xcos, scilab, super blocks'''

{|border
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “'''Super Blocks in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Use '''super block''' in '''Xcos.'''</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Windows 10 OS'''</blockquote></li>
<li><blockquote>'''Scilab 6.1.0'''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Linux''' OS also.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
Before practising this tutorial, a learner should have:

<ul>
<li><blockquote>Basic knowledge of '''Scilab and Xcos.'''</blockquote></li>
<li><blockquote>If not, for relevant tutorials please visit this website.</blockquote></li></ul>
|-
|
Show slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|

| First we will see why we need to use super blocks.
|-
|
'''Show slide:'''

Use of '''Super Blocks'''
|
<ul>
<li><blockquote>'''Xcos''' diagrams can grow with increasing complexity.</blockquote></li>
<li><blockquote>Larger more complicated '''Xcos''' diagrams are difficult to manage.</blockquote></li>
<li><blockquote>Super blocks help to organize the complicated '''Xcos''' diagrams.</blockquote></li></ul>
|-
|
'''Show slide:'''

What is a '''super block?'''
|
What is a '''super block?'''

<ul>
<li><blockquote>A block that can represent a group of connected blocks.</blockquote></li>
<li><blockquote>A complicated Xcos diagram can be represented with few super blocks.</blockquote></li>
<li><blockquote>Super block can contain another super block providing deeper simplification.</blockquote></li></ul>
|-
|

| We will now demonstrate a super block using an example.
|-
|
Show '''Scilab console.'''

Type '''xcos'''>>press '''Enter.'''
|
Open the '''Scilab console.'''

Type '''xcos''' and press '''Enter'''.

We can see two windows named '''Untitled Xcos''' and '''Palette browser''' opens'''.'''
|-
| Cursor on the '''Palette browser window''' and '''Untitled-Xcos window.'''
|
Notice the '''Palette browser window''' is located on the left side.

The '''Untitled''' - '''Xcos window''' is on the right side.
|-
|
'''File'''>>'''Open.'''

'''Downloads>>super-initial.xcos .'''

>>'''Open.'''
|
Go to the '''Untitled Xcos''' window.

In the '''menu bar,''' Click on '''File''' and then on '''Open'''.

Go to the '''Downloads''' folder and select the file '''Super-initial.xcos'''.

I have already created this file for demonstration of '''Super blocks.'''

Click on the Open button.

The file '''super-initial.xcos''' opens in the '''Xcos window.'''
|-
| Show '''palette browse'''r and '''Super-initial''' window.
| Now let's look at the contents of the file.
|-
|
Cursor on '''CONST block.'''

Cursor on '''POWBLK_f block.'''

Cursor on '''AFFICH_m block.'''

Cursor on '''CLOCK_c block.'''
|
We see that the file contains four blocks

<ul>
<li><blockquote>A '''CONST''' block</blockquote></li>
<li><blockquote>A '''POWBLK_f''' block</blockquote></li>
<li><blockquote>An '''AFFICH_m''' block and</blockquote></li>
<li><blockquote>A '''CLOCK_c''' block</blockquote></li></ul>
|-
| Cursor on '''CONST block'''.
| The '''CONST''' block will supply a constant value. In this file, I have given a value as 2.
|-
| Cursor on '''POWBLK_f block.'''
| The given value is then squared by the '''POWBLK_f''' block.
|-
| Cursor on '''AFFICH_m.'''
| The resultant value is displayed by the '''AFFICH_m''' block.
|-
| Cursor on '''CLOCK_c.'''
| The '''CLOCK_c block''' generates a regular and scheduled train of events.
|-
| Cursor on '''Scilab Multiple Values Reques'''t window.
|
Let us change the constant value to 3.

Double click on the '''CONST block'''.

The '''Scilab Multiple Values Request''' window opens.

Change the value of the block to 3 and click on OK.
|-
| Show '''super-initial xcos window.'''
|
Let us now execute the '''super-initial.xcos''' file.

First, we save the file by pressing '''Control and s''' keys simultaneously.

Then '''execute''' the file using the '''start''' button on the '''toolbar.'''

Here we can see the value is displayed as 9.0 in the '''AFFICH_ m''' block.
|-
|

|
Now we will demonstrate '''Super blocks''' using this example.

We will represent the squaring operation using a super block.

First, we will import the '''Super block''' into the '''super-initial.xcos''' window.
|-
|
Show '''palette browser.'''

'''Cursor on Palette list.'''

'''User defined functions>>SUPER_f.'''
|
Go to the '''palette browser''' window.

Here we can see a list of '''palettes''' on the left side'''.'''

Click on the '''User defined functions''' palette.

In the right panel, select the '''SUPER _ f''' block which is the super block.

Now, drag and drop it in the '''super-initial.xcos''' window.
|-
|
Show '''super-initial''' xcos window.

Hover cursor over '''POWBLK_f Block.'''
|
Here the '''POWBLK_f''' block is the operation block.

We will use the '''SUPER_f''' to represent the '''POWBLK _ f''' block.
|-
| Show '''untitled''' xcos window.
|
Double click on the '''SUPER _ f block.'''

We see another '''untitled xcos window''' open instead of '''parameters'''.

This '''Untitled Xcos window''' will have one input and output port by default.

Blocks connected to the input and output ports become part of the '''SUPER_f''' block.
|-
| Cursor on '''SUPER_f block.'''
| '''SUPER_f block''' will perform the squaring operation when connected to the '''super-initial.xcos''' file.
|-
| Cursor on '''POWBLK_f block.'''
| We will now transfer the '''POWBLK_f block''' into the '''Untitled Xcos''' window.
|-
|
Show '''super-initial''' xcos window.

Press '''Ctrl+X.'''
|
Click on the '''POWBLK_f''' block.

Press '''Control and X''' keys on the keyboard simultaneously.

This will cut the block from the file.
|-
|
Show '''Untitled''' xcos window.

Press '''Ctrl+V.'''
|
Go to the '''untitled''' '''xcos''' window.

Press '''Control and V''' keys on the keyboard simultaneously.
|-
| Cursor on '''POWBLK_f block.'''
| We can see the '''POWBLK_f block''' is transferred to the '''untitled''' '''xcos''' window.
|-
| Show '''Untitled''' xcos window.
|
Position the '''POWBLK_f block''' between the input and output ports.

Connect the black '''input port''' to the '''input port''' of the '''POWBLK_f block.'''

Connect the black '''output port''' of the '''POWBLK_f''' '''block''' to the '''output port.'''
|-
| Show '''super-initial''' xcos window.
|
Now we connect the '''SUPER_f block''' to the '''super-initial.xcos file.'''

Go to the '''super-initial.xcos''' window.
|-
| Cursor on '''SUPER_f block.'''
| Place the '''SUPER_f''' '''block''' between the '''CONST''' and '''AFFICH_m blocks.'''
|-
| Show '''super-initial''' xcos window.
|
Connect the black '''output port''' of '''CONST block''' to the input '''port''' of '''SUPER_f block.'''

Connect the black '''output port''' of '''SUPER_f block''' to the input '''port''' of '''AFFICH_m''' '''block'''.

All the necessary connections have been made.
|-
|

|
We have modified the '''super-initial.xcos''' file.

The squaring operation is now represented by a super block.

Now let us save and execute the '''super-initial.xcos''' file.
|-
|
Show '''super initial''' xcos window.

Cursor over the '''start''' button.

Cursor on '''AFFICH_m.'''
|
Press '''Control''' and '''S''' keys on the keyboard to save the file.

'''Execute''' the file using the '''start''' button on the '''toolbar.'''

We can see that the file runs without error and displays the result as '''9.0'''.

We got the desired result when we executed the file with the superblock as well.
|-
|
Show slide

'''Advantages of Super''' '''blocks'''
|
<ul>
<li><blockquote>We can segregate operations using '''super blocks.'''</blockquote></li>
<li><blockquote>In case of multiple operations, each operation can be represented by '''super blocks.'''</blockquote></li>
<li><blockquote>It will help to keep the diagram neat and understandable.</blockquote></li></ul>
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Use super blocks in '''Xcos.'''</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
For assignment activity, please do the following.

<ul>
<li><blockquote>Open the '''super-initial.xcos''' file.</blockquote></li>
<li><blockquote>Add an operation to multiply the output of the '''POWBLK_f''' block by 3.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
<ul>
<li><blockquote>Transfer the squaring and multiplications operations inside the '''SUPER_f''' block.</blockquote></li>
<li><blockquote>Save and execute the '''super-initial.xcos''' file.</blockquote></li></ul>

'''Hint''': Use the '''GAIN_f''' block to multiply the output by three.
|-
|
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'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|
This is '''Anandajith TS''', FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab/C4/Super-Blocks-in-Xcos/English

2021-09-01T19:39:01Z

Anandajitht:

'''Title of script''': Super Blocks in Xcos

'''Author: Rupak Rokade and Anandajith'''

'''Keywords: Xcos, scilab, super blocks'''

{|border
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “'''Super Blocks in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Use '''super block''' in '''Xcos.'''</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Windows 10 OS'''</blockquote></li>
<li><blockquote>'''Scilab 6.1.0 '''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Linux''' OS also.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
Before practising this tutorial, a learner should have:

<ul>
<li><blockquote>Basic knowledge of '''Scilab and Xcos.'''</blockquote></li>
<li><blockquote>If not, for relevant tutorials please visit this website.</blockquote></li></ul>
|-
|
Show slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|

| First we will see why we need to use super blocks.
|-
|
'''Show slide:'''

Use of '''Super Blocks'''
|
<ul>
<li><blockquote>'''Xcos''' diagrams can grow with increasing complexity.</blockquote></li>
<li><blockquote>Larger more complicated '''Xcos''' diagrams are difficult to manage.</blockquote></li>
<li><blockquote>Super blocks help to organize the complicated '''Xcos''' diagrams.</blockquote></li></ul>
|-
|
'''Show slide:'''

What is a '''super block?'''
|
What is a '''super block?'''

<ul>
<li><blockquote>A block that can represent a group of connected blocks</blockquote></li>
<li><blockquote>A complicated Xcos diagram can be represented with few super blocks.</blockquote></li>
<li><blockquote>Super block can contain another super block providing deeper simplification.</blockquote></li></ul>
|-
|

| We will now demonstrate a super block using an example.
|-
|
Show '''Scilab console.'''

Type '''xcos'''>>press '''Enter.'''
|
Open the '''Scilab console.'''

Type '''xcos''' and press '''Enter'''.

We can see two windows named '''Untitled Xcos''' and '''Palette browser''' opens'''.'''
|-
| Cursor on the '''Palette browser window''' and '''Untitled-Xcos window.'''
|
Notice the '''Palette browser window''' is located on the left side.

The '''Untitled''' - '''Xcos window''' is on the right side.
|-
|
'''File'''>>'''Open.'''

'''Downloads>>super-initial.xcos .'''

>>'''Open.'''
|
Go to the '''Untitled Xcos''' window.

In the '''menu bar,''' Click on '''File''' and then on '''Open'''.

Go to the '''Downloads''' folder and select the file '''Super-initial.xcos''' .

I have already created this file for demonstration of '''Super blocks.'''

Click on the Open button.

The file '''super-initial.xcos''' opens in the '''Xcos window.'''
|-
| Show '''palette browse'''r and '''Super-initial''' window.
| Now let's look at the contents of the file..
|-
|
Cursor on '''CONST block.'''

Cursor on '''POWBLK_f block.'''

Cursor on '''AFFICH_m block.'''

Cursor on '''CLOCK_c block.'''
|
We see that the file contains four blocks

<ul>
<li><blockquote>A '''CONST''' block</blockquote></li>
<li><blockquote>A '''POWBLK_f''' block</blockquote></li>
<li><blockquote>An '''AFFICH_m''' block and</blockquote></li>
<li><blockquote>A '''CLOCK_c''' block.</blockquote></li></ul>
|-
| Cursor on CONST block
| The '''CONST''' block will supply a constant value. In this file, I have given a value as 2.
|-
| Cursor on '''POWBLK_f block'''
| The given value is then squared by the '''POWBLK_f''' block.
|-
| Cursor on '''AFFICH_m'''
| The resultant value is displayed by the '''AFFICH_m''' block.
|-
| Cursor on '''CLOCK_c'''
| The '''CLOCK_c block''' generates a regular and scheduled train of events.
|-
| Cursor on '''Scilab Multiple Values Reques'''t window
|
Let us change the constant value to 3.

Double click on the '''CONST block'''.

The '''Scilab Multiple Values Request''' window opens.

Change the value of the block to 3 and click on OK.
|-
| Show '''super-initial xcos window'''
|
Let us now execute the '''super-initial.xcos''' file.

First, we save the file by pressing '''Control and s''' keys simultaneously.

Then '''execute''' the file using the '''start''' button on the '''toolbar.'''

Here we can see the value is displayed as 9.0 in the '''AFFICH_ m''' block.
|-
|

|
Now we will demonstrate '''Super blocks''' using this example.

We will represent the squaring operation using a super block.

First, we will import the '''Super block''' into the '''super-initial.xcos''' window.
|-
|
Show '''palette browser.'''

'''Cursor on Palette list .'''

'''User defined functions>>SUPER_f'''
|
Go to the '''palette browser''' window.

Here we can see a list of '''palettes''' on the left side'''.'''

Click on the '''User defined functions''' palette.

In the right panel, select the '''SUPER _ f''' block which is the super block.

Now, drag and drop it in the '''super-initial.xcos''' window.
|-
|
Show '''super-initial''' xcos window.

Hover cursor over '''POWBLK_f Block.'''
|
Here the '''POWBLK_f''' block is the operation block.

We will use the '''SUPER_f''' to represent the '''POWBLK _ f''' block.
|-
| Show '''untitled''' xcos window.
|
Double click on the '''SUPER _ f block.'''

We see another '''untitled xcos window''' open instead of '''parameters'''.

This '''Untitled Xcos window''' will have one input and output port by default.

Blocks connected to the input and output ports become part of the '''SUPER_f''' block.
|-
| Cursor on '''SUPER_f block'''
| '''SUPER_f block''' will perform the squaring operation when connected to the '''super-initial.xcos''' file.
|-
| Cursor on '''POWBLK_f block'''
| We will now transfer the '''POWBLK_f block''' into the '''Untitled Xcos''' window.
|-
|
Show '''super-initial''' xcos window.

Press '''Ctrl+X.'''
|
Click on the '''POWBLK_f''' block.

Press '''Control and X''' keys on the keyboard simultaneously.

This will cut the block from the file.
|-
|
Show '''Untitled''' xcos window.

Press '''Ctrl+V.'''
|
Go to the '''untitled''' '''xcos''' window.

Press '''Control and V''' keys on the keyboard simultaneously.
|-
| Cursor on '''POWBLK_f block'''
| We can see the '''POWBLK_f block''' is transferred to the '''untitled''' '''xcos''' window.
|-
| Show '''Untitled''' xcos window
|
Position the '''POWBLK_f block''' between the input and output ports.

Connect the black '''input port''' to the '''input port''' of the '''POWBLK_f block.'''

Connect the black '''output port''' of the '''POWBLK_f''' '''block''' to the '''output port.'''
|-
| Show '''super-initial''' xcos window.
|
Now we connect the '''SUPER_f block''' to the '''super-initial.xcos file.'''

Go to the '''super-initial.xcos''' window
|-
| Cursor on '''SUPER_f block'''
| Place the '''SUPER_f''' '''block''' between the '''CONST''' and '''AFFICH_m blocks.'''
|-
| Show '''super-initial''' xcos window.
|
Connect the black '''output port''' of '''CONST block''' to the input '''port''' of '''SUPER_f block.'''

Connect the black '''output port''' of '''SUPER_f block''' to the input '''port''' of '''AFFICH_m''' '''block'''.

All the necessary connections have been made.
|-
|

|
We have modified the '''super-initial.xcos''' file

The squaring operation is now represented by a super block.

Now let us save and execute the '''super-initial.xcos''' file.
|-
|
Show '''super initial''' xcos window.

Cursor over the '''start''' button.

Cursor on '''AFFICH_m'''
|
Press '''Control''' and '''S''' keys on the keyboard to save the file.

'''Execute''' the file using the '''start''' button on the '''toolbar.'''

We can see that the file runs without error and displays the result as '''9.0'''.

We got the desired result when we executed the file with the superblock as well.
|-
|
Show slide

'''Advantages of Super''' '''blocks'''
|
<ul>
<li><blockquote>We can segregate operations using '''super blocks'''</blockquote></li>
<li><blockquote>In case of multiple operations, each operation can be represented by '''super blocks'''</blockquote></li>
<li><blockquote>It will help to keep the diagram neat and understandable</blockquote></li></ul>
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Use super blocks in '''Xcos.'''</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
For assignment activity, please do the following.

<ul>
<li><blockquote>Open the '''super-initial.xcos''' file</blockquote></li>
<li><blockquote>Add an operation to multiply the output of the '''POWBLK_f''' block by 3.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
<ul>
<li><blockquote>Transfer the squaring and multiplications operations inside the '''SUPER_f''' block.</blockquote></li>
<li><blockquote>Save and execute the '''super-initial.xcos''' file.</blockquote></li></ul>

'''Hint''': Use the '''GAIN_f''' block to multiply the output by three.
|-
|
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'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|
This is '''Anandajith TS''', FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

Scilab/C4/Super-Blocks-in-Xcos/English

2021-08-07T06:54:20Z

Anandajitht: Created page with "'''Title of script''': Super Blocks in Xcos '''Author: Rupak Rokade and Anandajith''' '''Keywords: Xcos, scilab, super blocks''' {|border ! '''Visual Cue''' ! '''Narration..."

'''Title of script''': Super Blocks in Xcos

'''Author: Rupak Rokade and Anandajith'''

'''Keywords: Xcos, scilab, super blocks'''

{|border
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Hello and welcome to the Spoken Tutorial on “'''Super Blocks in Xcos'''”.
|-
|
Show Slide:

'''Learning Objectives'''
|
In this tutorial, we will learn how to:

<ul>
<li><blockquote>Use '''super block''' in '''Xcos.'''</blockquote></li></ul>
|-
|
Show Slide:

'''System Requirements'''
|
To record this tutorial, I am using:

<ul>
<li><blockquote>'''Windows 10 OS'''</blockquote></li>
<li><blockquote>'''Scilab 6.1.0 '''</blockquote></li></ul>

The process demonstrated in this tutorial is identical in '''Linux''' OS also.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
Before practising this tutorial, a learner should have:

<ul>
<li><blockquote>Basic knowledge of '''Scilab and Xcos.'''</blockquote></li>
<li><blockquote>If not, for relevant tutorials please visit this website.</blockquote></li></ul>
|-
|
Show slide:

'''Code Files'''
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|

| First we will see why we need to use super blocks.
|-
|
'''Show slide:'''

Use of '''Super Blocks'''
|
<ul>
<li><blockquote>'''Xcos''' diagrams can grow with increasing complexity.</blockquote></li>
<li><blockquote>Larger more complicated '''Xcos''' diagrams are difficult to manage.</blockquote></li>
<li><blockquote>Super blocks help to organize the complicated '''Xcos''' diagrams.</blockquote></li></ul>
|-
|
'''Show slide:'''

What is a '''super block?'''
|
What is a '''super block?'''

<ul>
<li><blockquote>A block that can represent a group of connected blocks</blockquote></li>
<li><blockquote>A complicated Xcos diagram can be represented with few super blocks.</blockquote></li>
<li><blockquote>Super block can contain another super block providing deeper simplification.</blockquote></li></ul>
|-
|

| We will now demonstrate a super block using an example.
|-
|
Show '''scilab console.'''

Type '''xcos'''>>press '''Enter.'''
|
Open the '''scilab console.'''

Type '''xcos''' and press '''Enter'''.

We can see two windows named '''Untitled Xcos''' and '''Palette browser''' opens'''.'''
|-
| Cursor on the '''Palette browser window''' and '''Untitled-Xcos window.'''
|
Notice the '''Palette browser window''' is located on the left side.

The '''Untitled''' - '''Xcos window''' is on the right side.
|-
|
'''File'''>>'''Open.'''

'''Downloads>>super-initial.xcos .'''

>>'''Open.'''
|
Go to the '''Untitled Xcos''' window.

In the '''menu bar,''' Click on '''File''' and then on '''Open'''.

Go to the '''Downloads''' folder and select the file '''Super-initial.xcos''' .

I have already created this file for demonstration of '''Super blocks.'''

Click on the Open button.

The file '''super-initial.xcos''' opens in the '''Xcos window.'''
|-
|
Show '''palette browse'''r and '''Super-initial''' window.

Cursor on '''CONST block.'''

Cursor on '''POWBLK_f block.'''

Cursor on '''AFFICH_m block.'''

Cursor on '''CLOCK_c block.'''

Cursor on CONST block

Cursor on '''POWBLK_f block'''

Cursor on '''AFFICH_m'''

Cursor on '''CLOCK_c'''
|
Now let's look at the contents of the file..

We see that the file contains four blocks

<ul>
<li><blockquote>A '''CONST''' block</blockquote></li>
<li><blockquote>A '''POWBLK_f''' block</blockquote></li>
<li><blockquote>An '''AFFICH_m''' block and</blockquote></li>
<li><blockquote>A '''CLOCK_c''' block.</blockquote></li></ul>

The '''CONST''' block will supply a constant value. In this file, I have given a value as 2.

The given value is then squared by the '''POWBLK_f''' block.

The resultant value is displayed by the '''AFFICH_m''' block.

The '''CLOCK_c block''' generates a regular and scheduled train of events.
|-
| Cursor on '''Scilab Multiple Values Reques'''t
|
Let us change the constant value to 3.

Double click on the '''CONST block'''.

The '''Scilab Multiple Values Request''' window opens.

Change the value of the block to 3 and click on OK.
|-
| Show '''super-initial xcos window'''
|
Let us now execute the '''super-initial.xcos''' file.

First we save the file by pressing '''Control and s''' keys simultaneously.

Then '''execute''' the file using the '''start''' button on the '''toolbar.'''

Here we can see the value is displayed as 9.0 in the '''AFFICH_ m''' block .
|-
|

|
Now we will demonstrate '''Super blocks''' using this example.

We will represent the squaring operation using a super block.

First we will import the '''Super block''' into the '''super-initial.xcos''' window.
|-
|
Show '''palette browser.'''

'''Cursor on Palette list .'''

'''User defined functions>>SUPER_f'''
|
Go to the '''palette browser''' window.

Here we can see a list of '''palettes''' on the left side'''.'''

Click on the '''User defined functions''' palette.

In the right panel, select the '''SUPER _ f''' block which is the super block.

Now, drag and drop it in the '''super-initial.xcos''' window.
|-
|
Show '''super-initial''' xcos window.

Hover cursor over '''POWBLK_f Block.'''
|
Here the '''POWBLK_f''' block is the operation block.

We will use the '''SUPER_f''' to represent the '''POWBLK _ f''' block.
|-
|
Show '''untitled''' xcos window.

Cursor on '''SUPER_f block'''

Cursor on '''POWBLK_f block'''
|
Double click on the '''SUPER _ f block.'''

We see another '''untitled xcos window''' open instead of '''parameters'''.

This '''Untitled Xcos window''' will have one input and output port by default.

Blocks connected to the input and output ports become part of the '''SUPER_f''' block.

'''SUPER_f block''' will perform the squaring operation when connected to the '''super-initial.xcos''' file.

We will now transfer the '''POWBLK_f block''' into the '''Untitled Xcos''' window.
|-
|
Cursor on '''super-initial''' xcos window.

Press '''Ctrl+X.'''
|
Click on the '''POWBLK_f''' block.

Press '''Control and X''' keys on the keyboard simultaneously.

This will cut the block from the file.
|-
|
Cursor on '''Untitled''' xcos window.

Press '''Ctrl+V.'''

Cursor on '''POWBLK_f block'''
|
Go to the '''untitled''' '''xcos''' window.

Press '''Control and V''' keys on the keyboard simultaneously.

We can see the '''POWBLK_f block''' is transferred to the '''untitled''' '''xcos''' window.

Position the '''POWBLK_f block''' between the input and output ports.

Connect the black '''input port''' to the '''input port''' of the '''POWBLK_f block.'''

Connect the black '''output port''' of the '''POWBLK_f''' '''block''' to the '''output port.'''
|-
|
Cursor on '''super-initial''' xcos window.

Cursor on '''SUPER_f block'''
|
Now we connect the '''SUPER_f block''' to the '''super-initial.xcos file.'''

Go to the '''super-initial.xcos''' window

Place the '''SUPER_f''' '''block''' between the '''CONST''' and '''AFFICH_m blocks.'''

Connect the black '''output port''' of '''CONST block''' to the input '''port''' of '''SUPER_f block.'''

Connect the black '''output port''' of '''SUPER_f block''' to the input '''port''' of '''AFFICH_m''' '''block'''.

All the necessary connections have been made.

We have modified the '''super-initial.xcos''' file

The squaring operation is now represented by a super block.

Now let us save and execute the '''super-initial.xcos''' file.
|-
|
Cursor on '''super initial''' xcos window.

Cursor over the '''start''' button.

Cursor on '''AFFICH_m'''
|
Press '''Control''' and '''S''' keys on the keyboard to save the file.

'''Execute''' the file using the '''start''' button on the '''toolbar.'''

We can see that the file runs without error and displays the result as '''9.0'''.

We got the desired result when we executed the file with the superblock as well.
|-
|
Show slide

'''Advantages of Super''' '''blocks'''
|
<ul>
<li><blockquote>We can segregate operations using '''super blocks'''</blockquote></li>
<li><blockquote>In case of multiple operations each operation can be represented by '''super blocks'''</blockquote></li>
<li><blockquote>It will help to keep the diagram neat and understandable</blockquote></li></ul>
|-
|
Show Slide:

'''Summary'''
|
This brings us to the end of this tutorial. Let us summarise.

In this tutorial, we have learnt to:

<ul>
<li><blockquote>Use super blocks in '''Xcos.'''</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
For assignment activity, please do the following.

<ul>
<li><blockquote>Open the '''super-initial.xcos''' file</blockquote></li>
<li><blockquote>Add an operation to multiply the output of the '''POWBLK_f''' block by 3.</blockquote></li></ul>
|-
|
Show Slide:

'''Assignment'''
|
<ul>
<li><blockquote>Transfer the squaring and multiplications operations inside the '''SUPER_f''' block.</blockquote></li>
<li><blockquote>Save and execute the '''super-initial.xcos''' file.</blockquote></li></ul>

'''Hint''': Use the '''GAIN_f''' block to multiply the output by three.
|-
|
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'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
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'''
|
This is '''Anandajith TS''', FOSSEE intern 2021, IIT Bombay signing off.

Thanks for joining.
|}

GUI-in-Scilab/C2/Creating-a-basic-GUI-using-Scilab/English

2021-08-06T13:08:23Z

Anandajitht:

'''Title of the script:''' Creating a basic '''GUI''' using Scilab

'''Author: Rashmi Patankar, Shwethaa R'''

{| border
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Welcome to the Spoken Tutorial on “Creating a basic '''GUI''' using Scilab”.
|-
|
Show Slide:

'''Learning objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>About '''Graphical User Interface(GUI)''' and its benefits.</blockquote></li></ul>

<ul>
<li><blockquote>Create a '''pushbutton.'''</blockquote></li>
<li><blockquote>Add a '''callback function''' and</blockquote></li></ul>

<ul>
<li><blockquote>Create a basic '''GUI''' using '''Scilab.'''</blockquote></li></ul>
|-
|
Show Slide:

'''System requirement'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Windows 10''' '''OS''' and</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0'''</blockquote></li></ul>

The process demonstrated in this tutorial is similar in Linux OS.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab'''.</blockquote></li></ul>

<ul>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

Code Files
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

What is a '''Graphical User Interface'''?
|
The '''Graphical User Interface(GUI)''' is:

<ul>
<li><blockquote>A graphical display that allows the user to do interactive tasks using objects.</blockquote></li>
<li><blockquote>Users can create and arrange objects in a graphical window.</blockquote></li></ul>
|-
|
Show Slide:

What is a '''Graphical User Interface'''?
|
<ul>
<li><blockquote>The object style includes '''edit, slider,''' '''pushbutton,''' etc.</blockquote></li>
<li><blockquote>We use their '''callbacks''' to make them interactive.</blockquote></li>
<li><blockquote>'''GUI'''s can also create and display '''data''' in a tabular form or as a '''plot'''.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a pushbutton?'''
| A '''pushbutton''' is a rectangular button used to run a '''callback.'''
|-
|
Show Slide:

'''What is a callback?'''
|
A '''callback''' is a '''function''' that executes a set of '''commands.'''

This happens in response to a predefined user action.

For example,

<ul>
<li><blockquote>When the '''pushbutton''' is pressed, the code written in the '''callback''' is '''executed'''.</blockquote></li>
<li><blockquote>As a result, the '''pushbutton''' becomes interactive.</blockquote></li></ul>
|-
|
On the '''Scilab console''',

type '''editor''' and press '''Enter.'''
|
Open the '''Scilab console'''.

Type '''editor''' and press '''Enter.'''
|-
|
On '''Scinotes Window,'''

highlight '''Scinotes''' on title bar.

Click on '''File'''>>'''Open.'''
|
It opens the '''Scinotes''' window.

Click on '''File''' on the '''menubar''' and then on '''Open.'''
|-
|
On '''Open Window,'''

go to '''Downloads''' folder >> Click on '''basicgui.sce''' file >> Click '''Open.'''

Video-editor: Pls put a textbox on screen. “In Ubuntu Linux OS, click on Ok button.”
|
Go to the '''Downloads''' folder.

Locate the file '''basicgui.sce''' and click on it.

Click on the '''Open''' button at the bottom.
|-
|
On '''Scinotes''' Window,

hover cursor over '''basicgui.sce''' in the title bar.
|
It opens the file '''basicgui.sce''' in '''Scinotes''' window.

Now we’ll look at the code.
|-
|
Cursor on '''SciNotes Window, '''

highlight '''figure().'''
|
Let's start by creating a '''graphic window.'''

The '''graphic window''' is a window on which we place the objects to create a '''GUI'''.

For creating that''',''' the '''figure function''' is used.
|-
| Cursor on '''SciNotes Window,''' highlight the word '''f.'''
|
'''‘f’''' is the handle of the '''graphic window.'''

It is used to change the properties of the '''graphic window''' after it is created.
|-
|
Cursor on '''Scinotes Window,'''

highlight the line with '''f.visible.'''
|
We then use handle '''‘f'''' to set the '''visible''' property of a '''graphic window''' to '''“ON”.'''

Hence, the '''pushbutton''' becomes visible on a '''graphic window''' after it is created.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''uicontrol.'''
|
The '''uicontrol function''' is used to create a '''pushbutton''' in a '''graphic window'''.

It sets the properties of a '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''h1.'''
|
'''‘h1’''' is the handle of the '''pushbutton.'''

The handle is used to change the properties of a '''pushbutton''' after it is created.

It is also used while writing a '''callback function'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''f''' inside '''uicontrol''' parentheses.
|
Notice that ‘'''f’''' is '''pass'''ed as a first '''argument''' within the '''uicontrol function'''.

So the '''pushbutton''' we make will appear in the '''graphic window''' whose handle is ''''f''''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''style''' and '''pushbutton.'''
| The object '''style''' is set to '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''Position''' and numbers inside '''square brackets'''.
| '''Position''' and size of a '''pushbutton''' is defined within '''square brackets'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''250.'''
| '''250 units''' is the margin from the left side of the window.
|-
|
Cursor on '''Scinotes Window, '''

highlight number '''200.'''
| '''200 units''' is the margin from the top side of the window.
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''100.'''
| '''100 units''' is the width of the '''pushbutton.'''
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''50.'''
| '''50 units''' is the height of the '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''string''' and '''Print.'''
|
The '''string''' denotes the text that appears on top of a '''pushbutton.'''

As we can see, it is set to '''Print'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''callback''' and '''callback_print(h1).'''
| Let us set the '''callback''' property to call the '''function callback_print(h1).'''
|-
|
Cursor on '''Scinotes Window, '''

hover over '''style, position, string''' and '''callback.'''
|
Notice the '''arguments style, position, string''' and '''callback'''.

They are basically the '''property''' names.
|-
|
Cursor on '''Scinotes Window,'''

hover cursor over '''pushbutton, square bracket, Print''' and '''callback_print(h1)'''.
|
Notice the '''arguments - pushbutton, square bracket, Print''' and '''callback_print(h1).'''

They represent the respective '''property''' values.
|-
|
Cursor on '''Scinotes Window,'''

highlight the three dots.

Highlight the lines inside '''uicontrol''' parentheses.
|
There are three dots after ''''f'''' and '''property''' values.

They are used to split the multiple '''arguments''' onto separate lines.

The '''arguments''' within the '''parenthesis'''

can also be written on a single line.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''callback_print(h1)''' function definition.

highlight '''h1''' within parentheses
|
Let us look at the definition of '''callback_print(h1) function.'''

Notice that we have '''pass'''ed '''h1''' as an '''argument''' to this '''function'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the line disp'''(“Hello World”).'''
|
You can see that this '''function''' contains only one '''command.'''

This will display the message “'''Hello World”''' in the '''Scilab''' '''console.'''

The message will be displayed only after we press the '''pushbutton'''.
|-
| Press '''Ctrl+S''' simultaneously.
| Save the file by pressing '''Control''' and ‘'''S'''’ keys simultaneously.
|-
|
In '''Scinotes Window,'''

click on '''Execute''' menu, '''File with echo.'''
|
To '''run''' the file, click on the '''Execute menu''' first.

Then click on '''File with echo''' from the drop-down menu.
|-
|
In '''Graphic Window number 0,'''

highlight the '''Graphic Window number 0''' on the title bar.

Hover cursor over '''Print''' '''pushbutton.'''

click on '''Print.'''
|
A window named '''Graphic Window number 0''' opens.

A '''pushbutton''' named '''Print''' appears'''.'''

Click on '''Print.'''
|-
|
Switch to '''Scilab Console.'''

highlight the message “'''Hello World'''” on '''Scilab console.'''
|
Switch to the '''Scilab console''' to view the output.

The '''console''' shows the message “'''Hello World”'''.

You can see that we got the desired result when we pressed the '''pushbutton'''.
|-
|

| This brings us to the end of this tutorial'''.''' Let us summarize.
|-
|
Show Slide:

'''Summary'''
|
In this tutorial, we have learnt:

<ul>
<li><blockquote>About a '''Graphical User Interface(GUI)''' and its benefits.</blockquote></li>
<li><blockquote>Created a '''pushbutton.'''</blockquote></li>
<li><blockquote>Added a '''callback function.'''</blockquote></li>
<li><blockquote>Created a basic '''GUI''' using '''Scilab.'''</blockquote></li></ul>
|-
|
Show Slide:

Assignment
|
As an assignment, please do the following.

Add one more '''pushbutton''' to the current '''GUI''' as described below,

<ol style="list-style-type: decimal;">
<li><blockquote>Size, Height: '''200 units''' Width: '''100 units'''.</blockquote></li>
<li><blockquote>Position: Align it below the '''Print''' '''pushbutton''' with a gap of '''20 units.'''</blockquote></li></ol>
|-
|
Show Slide:

Assignment
|
<ol style="list-style-type: decimal;">
<li><blockquote>Add a '''String''' named ''''Press here'''' for the '''pushbutton'''.</blockquote></li>
<li><blockquote>Add a '''callback function''' to display the message ''''Good day!'''' on the '''Scilab console'''.</blockquote></li></ol>

<blockquote>Hint: The name of the '''function''' must be different.
</blockquote>
|-
|
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'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

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:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education,''' '''Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
The script has been created by '''FOSSEE Team and FOSSEE intern Shwethaa'''.

The video for this tutorial was created by me '''Anandajith''', I am a '''FOSSEE''' intern signing off.

Thanks for watching.
|}

GUI-in-Scilab/C2/Creating-a-basic-GUI-using-Scilab/English

2021-08-06T10:50:15Z

Anandajitht: Created page with "'''Title of the script:''' Creating a basic '''GUI''' using Scilab '''Author: Rashmi Patankar, Shwethaa R''' '''Outline: ''' <ol style="list-style-type: decimal;"> <li><blo..."

'''Title of the script:''' Creating a basic '''GUI''' using Scilab

'''Author: Rashmi Patankar, Shwethaa R'''

'''Outline: '''

<ol style="list-style-type: decimal;">
<li><blockquote>Learn about '''GUI''' and its benefits,</blockquote></li>
<li><blockquote>What are '''objects,'''</blockquote></li>
<li><blockquote>What is a '''pushbutton,'''</blockquote></li>
<li><blockquote>What is a '''callback''' function,</blockquote></li>
<li><blockquote>Use of a '''graphic window,'''</blockquote></li>
<li><blockquote>About '''figure''' function,</blockquote></li>
<li><blockquote>About '''uicontrol''' function,</blockquote></li>
<li><blockquote>About '''object''' properties,</blockquote></li>
<li><blockquote>Position the '''pushbutton''' in the '''GUI''',</blockquote></li>
<li><blockquote>Add a '''callback''' function.</blockquote></li></ol>

{|
! '''Visual Cue'''
! '''Narration'''
|-
|
Show Slide:

'''Title Slide'''
| Welcome to the Spoken Tutorial on “Creating a basic '''GUI''' using Scilab”.
|-
|
Show Slide:

'''Learning objectives'''
|
In this tutorial, we will learn:

<ul>
<li><blockquote>About '''Graphical User Interface(GUI)''' and its benefits.</blockquote></li></ul>

<ul>
<li><blockquote>Create a '''pushbutton.'''</blockquote></li>
<li><blockquote>Add a '''callback function''' and</blockquote></li></ul>

<ul>
<li><blockquote>Create a basic '''GUI''' using '''Scilab.'''</blockquote></li></ul>
|-
|
Show Slide:

'''System requirement'''
|
To record this tutorial, I am using

<ul>
<li><blockquote>'''Windows 10''' '''OS''' and</blockquote></li></ul>

<ul>
<li><blockquote>'''Scilab''' '''6.1.0'''</blockquote></li></ul>

The process demonstrated in this tutorial is similar in Linux OS.

Annotations are added to the tutorial if there are any differences.
|-
|
Show Slide:

'''Pre-requisites'''

https://www.spoken-tutorial.org
|
<ul>
<li><blockquote>The learner must have basic knowledge of '''Scilab'''.</blockquote></li></ul>

<ul>
<li><blockquote>For pre-requisite '''Scilab''' tutorials please visit this website.</blockquote></li></ul>
|-
|
Show Slide:

Code Files
|
<ul>
<li><blockquote>The files used in this tutorial are provided in the '''Code files''' link.</blockquote></li>
<li><blockquote>Please download and extract the files.</blockquote></li>
<li><blockquote>Make a copy and then use them while practising.</blockquote></li></ul>
|-
|
Show Slide:

What is a '''Graphical User Interface'''?
|
The '''Graphical User Interface(GUI)''' is:

<ul>
<li><blockquote>A graphical display that allows the user to do interactive tasks using objects.</blockquote></li>
<li><blockquote>Users can create and arrange objects in a graphical window.</blockquote></li></ul>
|-
|
Show Slide:

What is a '''Graphical User Interface'''?
|
<ul>
<li><blockquote>The object style includes '''edit, slider,''' '''pushbutton,''' etc.</blockquote></li>
<li><blockquote>We use their '''callbacks''' to make them interactive.</blockquote></li>
<li><blockquote>'''GUI'''s can also create and display '''data''' in a tabular form or as a '''plot'''.</blockquote></li></ul>
|-
|
Show Slide:

'''What is a pushbutton?'''
| A '''pushbutton''' is a rectangular button used to run a '''callback.'''
|-
|
Show Slide:

'''What is a callback?'''
|
A '''callback''' is a '''function''' that executes a set of '''commands.'''

This happens in response to a predefined user action.

For example,

<ul>
<li><blockquote>When the '''pushbutton''' is pressed, the code written in the '''callback''' is '''executed'''.</blockquote></li>
<li><blockquote>As a result, the '''pushbutton''' becomes interactive.</blockquote></li></ul>
|-
|
On the '''Scilab console''',

type '''editor''' and press '''Enter.'''
|
Open the '''Scilab console'''.

Type '''editor''' and press '''Enter.'''
|-
|
On '''Scinotes Window,'''

highlight '''Scinotes''' on title bar.

Click on '''File'''>>'''Open.'''
|
It opens the '''Scinotes''' window.

Click on '''File''' on the '''menubar''' and then on '''Open.'''
|-
|
On '''Open Window,'''

go to '''Downloads''' folder >> Click on '''basicgui.sce''' file >> Click '''Open.'''

Video-editor: Pls put a textbox on screen. “In Ubuntu Linux OS, click on Ok button.”
|
Go to the '''Downloads''' folder.

Locate the file '''basicgui.sce''' and click on it.

Click on the '''Open''' button at the bottom.
|-
|
On '''Scinotes''' Window,

hover cursor over '''basicgui.sce''' in the title bar.
|
It opens the file '''basicgui.sce''' in '''Scinotes''' window.

Now we’ll look at the code.
|-
|
Cursor on '''SciNotes Window, '''

highlight '''figure().'''
|
Let's start by creating a '''graphic window.'''

The '''graphic window''' is a window on which we place the objects to create a '''GUI'''.

For creating that''',''' the '''figure function''' is used.
|-
| Cursor on '''SciNotes Window,''' highlight the word '''f.'''
|
'''‘f’''' is the handle of the '''graphic window.'''

It is used to change the properties of the '''graphic window''' after it is created.
|-
|
Cursor on '''Scinotes Window,'''

highlight the line with '''f.visible.'''
|
We then use handle '''‘f'''' to set the '''visible''' property of a '''graphic window''' to '''“ON”.'''

Hence, the '''pushbutton''' becomes visible on a '''graphic window''' after it is created.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''uicontrol.'''
|
The '''uicontrol function''' is used to create a '''pushbutton''' in a '''graphic window'''.

It sets the properties of a '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''h1.'''
|
'''‘h1’''' is the handle of the '''pushbutton.'''

The handle is used to change the properties of a '''pushbutton''' after it is created.

It is also used while writing a '''callback function'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''f''' inside '''uicontrol''' parentheses.
|
Notice that ‘'''f’''' is '''pass'''ed as a first '''argument''' within the '''uicontrol function'''.

So the '''pushbutton''' we make will appear in the '''graphic window''' whose handle is ''''f''''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''style''' and '''pushbutton.'''
| The object '''style''' is set to '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the word '''Position''' and numbers inside '''square brackets'''.
| '''Position''' and size of a '''pushbutton''' is defined within '''square brackets'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''250.'''
| '''250 units''' is the margin from the left side of the window.
|-
|
Cursor on '''Scinotes Window, '''

highlight number '''200.'''
| '''200 units''' is the margin from the top side of the window.
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''100.'''
| '''100 units''' is the width of the '''pushbutton.'''
|-
|
Cursor on '''Scinotes Window,'''

highlight number '''50.'''
| '''50 units''' is the height of the '''pushbutton'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''string''' and '''Print.'''
|
The '''string''' denotes the text that appears on top of a '''pushbutton.'''

As we can see, it is set to '''Print'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''callback''' and '''callback_print(h1).'''
| Let us set the '''callback''' property to call the '''function callback_print(h1).'''
|-
|
Cursor on '''Scinotes Window, '''

hover over '''style, position, string''' and '''callback.'''
|
Notice the '''arguments style, position, string''' and '''callback'''.

They are basically the '''property''' names.
|-
|
Cursor on '''Scinotes Window,'''

hover cursor over '''pushbutton, square bracket, Print''' and '''callback_print(h1)'''.
|
Notice the '''arguments - pushbutton, square bracket, Print''' and '''callback_print(h1).'''

They represent the respective '''property''' values.
|-
|
Cursor on '''Scinotes Window,'''

highlight the three dots.

Highlight the lines inside '''uicontrol''' parentheses.
|
There are three dots after ''''f'''' and '''property''' values.

They are used to split the multiple '''arguments''' onto separate lines.

The '''arguments''' within the '''parenthesis'''

can also be written on a single line.
|-
|
Cursor on '''Scinotes Window,'''

highlight '''callback_print(h1)''' function definition.

highlight '''h1''' within parentheses
|
Let us look at the definition of '''callback_print(h1) function.'''

Notice that we have '''pass'''ed '''h1''' as an '''argument''' to this '''function'''.
|-
|
Cursor on '''Scinotes Window,'''

highlight the line disp'''(“Hello World”).'''
|
You can see that this '''function''' contains only one '''command.'''

This will display the message “'''Hello World”''' in the '''Scilab''' '''console.'''

The message will be displayed only after we press the '''pushbutton'''.
|-
| Press '''Ctrl+S''' simultaneously.
| Save the file by pressing '''Control''' and ‘'''S'''’ keys simultaneously.
|-
|
In '''Scinotes Window,'''

click on '''Execute''' menu, '''File with echo.'''
|
To '''run''' the file, click on the '''Execute menu''' first.

Then click on '''File with echo''' from the drop-down menu.
|-
|
In '''Graphic Window number 0,'''

highlight the '''Graphic Window number 0''' on the title bar.

Hover cursor over '''Print''' '''pushbutton.'''

click on '''Print.'''
|
A window named '''Graphic Window number 0''' opens.

A '''pushbutton''' named '''Print''' appears'''.'''

Click on '''Print.'''
|-
|
Switch to '''Scilab Console.'''

highlight the message “'''Hello World'''” on '''Scilab console.'''
|
Switch to the '''Scilab console''' to view the output.

The '''console''' shows the message “'''Hello World”'''.

You can see that we got the desired result when we pressed the '''pushbutton'''.
|-
|

| This brings us to the end of this tutorial'''.''' Let us summarize.
|-
|
Show Slide:

'''Summary'''
|
In this tutorial, we have learnt:

<ul>
<li><blockquote>About a '''Graphical User Interface(GUI)''' and its benefits.</blockquote></li>
<li><blockquote>Created a '''pushbutton.'''</blockquote></li>
<li><blockquote>Added a '''callback function.'''</blockquote></li>
<li><blockquote>Created a basic '''GUI''' using '''Scilab.'''</blockquote></li></ul>
|-
|
Show Slide:

Assignment
|
As an assignment, please do the following.

Add one more '''pushbutton''' to the current '''GUI''' as described below,

<ol style="list-style-type: decimal;">
<li><blockquote>Size, Height: '''200 units''' Width: '''100 units'''.</blockquote></li>
<li><blockquote>Position: Align it below the '''Print''' '''pushbutton''' with a gap of '''20 units.'''</blockquote></li></ol>
|-
|
Show Slide:

Assignment
|
<ol style="list-style-type: decimal;">
<li><blockquote>Add a '''String''' named ''''Press here'''' for the '''pushbutton'''.</blockquote></li>
<li><blockquote>Add a '''callback function''' to display the message ''''Good day!'''' on the '''Scilab console'''.</blockquote></li></ol>

<blockquote>Hint: The name of the '''function''' must be different.
</blockquote>
|-
|
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'''
|
We conduct workshops using '''Spoken Tutorials''' and give certificates.

Please contact us.
|-
|
Show Slide:

'''Answers for THIS Spoken Tutorial'''
| Please post your timed queries in this forum.
|-
| Show Slide: '''FOSSEE Forum'''
| Please post your general and technical queries on '''Scilab''' in this forum.
|-
|
Show Slide:

'''Textbook Companion project'''
|
The '''FOSSEE''' team coordinates the '''TBC''' project.

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:

'''Acknowledgements'''
| The '''Spoken Tutorial''' project is funded by the '''Ministry of Education,''' '''Government of India'''.
|-
|
Show slide:

'''Thank you'''
|
The script has been created by '''FOSSEE Team and FOSSEE intern Shwethaa'''.

The video for this tutorial was created by me '''Anandajith''', I am a '''FOSSEE''' intern signing off.

Thanks for watching.
|}