Difference between revisions of "Osdag/C2/Installation-of-Osdag-in-Ubuntu/English"

From Script | Spoken-Tutorial
Jump to: navigation, search
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
'''Author''': Zahran Sajid
 
'''Author''': Zahran Sajid
  
'''Keywords:''' Osdag, Installation, Ubuntu Linux, Osdag, Terminal, text editor, video tutorial.
+
'''Keywords:''' Osdag, Installation, Ubuntu Linux, Terminal, Miniconda, sample design, Fin Plate, CAD model, conda, text editor, video tutorial.
  
  
 
{|border=1
 
{|border=1
| align=center| Visual Cue
+
| align=center| '''Visual Cue'''
| align=center| Narration
+
| align=center| '''Narration'''
 
|-  
 
|-  
 
||'''Slide:'''  
 
||'''Slide:'''  
  
'''Title Slide
+
'''Title Slide'''
|| Welcome to the spoken tutorial on '''‘Installation''' '''of Osdag in Ubuntu’.'''
+
 
 +
|| Welcome to the spoken tutorial on '''‘Installation of Osdag in Ubuntu’'''.
 
|-  
 
|-  
|| '''Slide: '''Learning Objectives
+
|| '''Slide''':  
 +
 
 +
'''Learning Objectives
 
|| In this tutorial, we will learn to:
 
|| In this tutorial, we will learn to:
* Download and install '''Osdag''' in '''Ubuntu Linux OS'''
+
 
 +
* Download and install '''Osdag''' in '''Ubuntu Linux operating system'''
 
* Open '''Osdag '''through '''Terminal'''
 
* Open '''Osdag '''through '''Terminal'''
 
* Verify the installation
 
* Verify the installation
Line 27: Line 31:
 
'''System Requirements'''
 
'''System Requirements'''
 
|| To record this tutorial, I am using:
 
|| 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
 
  
 +
* '''Ubuntu Linux''' 20.04
 +
* '''Osdag''' version 2021(v2021.02.a.a12f)
 +
* '''gedit text editor''',  and
 +
* A working '''internet ''' connection
  
 
|-  
 
|-  
Line 40: Line 44:
 
[https://spoken-tutorial.org/ https://spoken-tutorial.org]  
 
[https://spoken-tutorial.org/ https://spoken-tutorial.org]  
 
|| To follow this tutorial, the user should be familiar with,
 
|| To follow this tutorial, the user should be familiar with,
 +
 
* Basic '''Linux '''commands
 
* Basic '''Linux '''commands
 
* A text editor in '''Linux''', and
 
* A text editor in '''Linux''', and
 
* Basics of '''structural steel design'''
 
* Basics of '''structural steel design'''
  
For prerequisite '''Linux''' and '''gedit Text Editor '''tutorials please visit this website.
+
For prerequisite '''Linux''' and '''gedit Text Editor ''' tutorials please visit this website.
 
|-  
 
|-  
 
||'''Slide:'''  
 
||'''Slide:'''  
 +
 
'''Hardware Requirements'''
 
'''Hardware Requirements'''
|| For a successful installation, we will need
+
|| For a successful installation, we will need,
* '''64-bit''' '''Ubuntu Linux''' (18.04 or later version)
+
 
* Minimum of ''' 4 GB''' '''RAM'''
+
* '''64-bit Ubuntu Linux''' 18.04 or later version
* Minimum of ''' 4 GB''' '''hard disk''' space
+
* Minimum of 4 '''GB RAM'''.
 +
* Minimum of 4 '''GB hard disk''' space.
  
  
 
|-
 
|-
|| '''Slide: '''Code Files
+
|| '''Slide''':  
 +
 
 +
'''Code Files'''
 
||  
 
||  
* The files used in this tutorial are available in the '''Code Files ''' link
+
* The files used in this tutorial are available in the '''Code Files ''' link.
* Please download and extract them
+
* Please download and extract them.
* Make a copy and then use them while practising
+
* Make a copy and then use them while practising.
  
  
Line 71: Line 80:
 
|| Only Narration
 
|| Only Narration
  
Press '''Ctrl, Shift, '''and '''V ''' keys to paste in the Terminal.
+
Press '''Ctrl''', '''Shift''', and '''V ''' keys to paste in the '''Terminal'''.
 
|| I will use the same file to copy the '''commands''' during the demonstration.
 
|| 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.
+
'''Commands''' on the '''terminal''' can be pasted by pressing the '''Ctrl''', '''Shift''', and '''V ''' keys together.
 
|-
 
|-
 
||Only Narration
 
||Only Narration
Line 81: Line 90:
  
  
Open any '''web browser '''of your choice.
+
Open any '''web browser ''' of your choice.
 
|-  
 
|-  
 
|| Open '''Mozilla Firefox'''
 
|| Open '''Mozilla Firefox'''
 
|| I have opened the '''Mozilla Firefox''' web browser.
 
|| I have opened the '''Mozilla Firefox''' web browser.
 
|-  
 
|-  
|| Type''' '''‘'''osdag.fossee.in'''’ and press '''Enter'''
+
|| Type ‘'''osdag.fossee.in'''’ and press '''Enter'''
 
|| In the '''address bar''' type the '''URL ‘osdag.fossee.in’''' and press '''Enter'''.
 
|| In the '''address bar''' type the '''URL ‘osdag.fossee.in’''' and press '''Enter'''.
 
|-
 
|-
Line 95: Line 104:
  
 
Click on “'''Downloads'''” tab.
 
Click on “'''Downloads'''” tab.
|| In the top '''menu bar''', click on the '''Downloads''' tab'''.
+
|| In the top '''menu bar''', click on the '''Downloads ''' tab'''.
 
|-
 
|-
 
|| Point toward the '''Downloads''' page
 
|| Point toward the '''Downloads''' page
Line 101: Line 110:
  
  
The ''' Osdag installers''' for '''Ubuntu Linux''' and '''Windows OS ''' are listed here.
+
The ''' Osdag installers''' for '''Ubuntu Linux''' and '''Windows operating system ''' are listed here.
 
|-
 
|-
 
||Scroll and point towards the release dates.
 
||Scroll and point towards the release dates.
Line 107: Line 116:
 
|-
 
|-
 
|| Point towards '''1. Installer [Release: 2021-02-15]'''
 
|| Point towards '''1. Installer [Release: 2021-02-15]'''
||The topmost '''installer ''' is for the latest '''version '''of '''Osdag.'''
+
||The topmost '''installer ''' is for the latest '''version ''' of '''Osdag'''.
 
|-  
 
|-  
 
||Scroll the page to show the older versions.
 
||Scroll the page to show the older versions.
|| Older versions of '''Osdag '''are listed below.
+
|| Older versions of '''Osdag ''' are listed below.
 
|-  
 
|-  
 
|| '''Mozilla Firefox:'''
 
|| '''Mozilla Firefox:'''
  
 
Click on '''Installer-Linux'''
 
Click on '''Installer-Linux'''
|| Click on the '''Installer-Linux '''link.
+
|| Click on the '''Installer-Linux ''' link.
 
|-  
 
|-  
||Only Narration
+
||Cursor in the '''Osdag''' page.
|| We will be redirected to the '''Osdag User Information Form '''page.
+
|| We will be redirected to the '''Osdag User Information Form''' page.
 
|-  
 
|-  
 
|| '''Mozilla Firefox:'''
 
|| '''Mozilla Firefox:'''
Line 124: Line 133:
 
Show filled '''Osdag User Information Form'''
 
Show filled '''Osdag User Information Form'''
  
|| To download the '''Osdag '''Installer, the required details must be filled in.
+
|| To download the '''Osdag ''' Installer, the required details must be filled in.
  
I have already filled the '''form.'''
+
I have already filled the '''form'''.
  
 
|-  
 
|-  
||Only Narration
+
||Cursor in the form.
 
|| The details will be used for internal '''quality assessment''' purposes only.
 
|| The details will be used for internal '''quality assessment''' purposes only.
  
Line 135: Line 144:
 
So, please do not hesitate to submit the details.
 
So, please do not hesitate to submit the details.
 
|-
 
|-
|| Click on '''Submit'''
+
|| Click on '''Submit'''.
||Click on '''Submit''' at the end of the '''form '''to start downloading the '''Osdag installer.'''
+
||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'''
 
|| 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.
+
||'''Osdag '''installer is now downloaded and saved to the '''Downloads directory ''' on my system.
  
 
|-
 
|-
Line 149: Line 158:
 
|| Show '''terminal '''and '''gedit '''text editor opened side-by-side
 
|| Show '''terminal '''and '''gedit '''text editor opened side-by-side
  
Press Ctrl + Alt+ T keys to open the Terminal.
+
Press '''Ctrl''' + '''Alt''' + '''T''' keys to open the Terminal.
|| I have opened the '''terminal '''and '''gedit '''text editor.
+
|| I have opened the '''terminal ''' and '''gedit ''' text editor.
  
 
I will switch between them as required.
 
I will switch between them as required.
Line 156: Line 165:
 
|-
 
|-
 
||Only Narration
 
||Only Narration
|| I will now go to the '''Downloads directory''' where I have saved the''' installer '''file.
+
|| 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.
+
Users need to choose the '''directory''' where the '''installer ''' file is saved.
 
|-
 
|-
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Type '''cd (space) Downloads''' and press''' Enter'''
 
Type '''cd (space) Downloads''' and press''' Enter'''
|| In the '''terminal''', I will type '''cd (space) Downloads''' and press''' Enter.'''
+
|| In the '''terminal''', I will type '''cd (space) Downloads''' and press ''' Enter'''.
 
|-
 
|-
||Only Narration
+
||Cursor in the Terminal window.
|| Here onwards, please remember to press the '''Enter''' '''key ''' after typing each '''command.'''
+
|| Here on wards, please remember to press the '''Enter key''' after typing each '''command'''.
 
|-
 
|-
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Type '''ls '''and press '''Enter'''
 
Type '''ls '''and press '''Enter'''
|| Type '''ls''' to check whether the '''installer''' file is listed in the '''current directory.'''
+
|| Type '''ls''' to check whether the '''installer''' file is listed in the '''current directory'''.
 
|-
 
|-
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Point towards '''Osdag_ubuntu_installer_v2021.02.a.a12f.tar.gz''' file
 
Point towards '''Osdag_ubuntu_installer_v2021.02.a.a12f.tar.gz''' file
||  
+
|| The list shows the '''installer''' file.
 
+
The list shows the '''installer''' file.
+
 
|-
 
|-
 
|| '''gedit '''text editor''':'''
 
|| '''gedit '''text editor''':'''
  
 
Copy '''tar -xvf Osdag_ubuntu_installer_v2021.02.a.a12f.tar.gz'''
 
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.'''
+
|| To extract the '''installer''' file, copy the first '''command''' from the '''Code file'''.
 
|-
 
|-
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Paste in the '''Terminal''' and press '''Enter'''
 
Paste in the '''Terminal''' and press '''Enter'''
|| Paste it in the '''terminal''' and press '''Enter.'''
+
|| Paste it in the '''terminal''' and press '''Enter'''.
 
|-
 
|-
 
||Only Narration
 
||Only Narration
||Now we have to navigate into the extracted '''Osdag installer folder.'''
+
||Now we have to navigate into the extracted '''Osdag installer folder'''.
 
|-
 
|-
 
||'''gedit '''text editor''':'''
 
||'''gedit '''text editor''':'''
Line 202: Line 209:
 
||'''Terminal:'''
 
||'''Terminal:'''
  
Paste in the '''Terminal''' and press '''Enter'''
+
Paste in the '''Terminal''' and press '''Enter'''.
||Paste it in the '''terminal '''and press '''Enter.'''
+
||Paste it in the '''terminal ''' and press '''Enter'''.
 
|-  
 
|-  
 
|| '''Slide:'''
 
|| '''Slide:'''
Line 209: Line 216:
 
'''Installation Steps'''
 
'''Installation Steps'''
  
|| Installing '''Osdag '''is a two-step process
+
|| Installing '''Osdag ''' is a two-step process
 
* First step is to install '''Miniconda'''
 
* First step is to install '''Miniconda'''
 
* Second step is to install '''Osdag'''
 
* Second step is to install '''Osdag'''
Line 219: Line 226:
 
What is Miniconda?
 
What is Miniconda?
 
||  
 
||  
* '''Conda''' is a '''cross-platform package manager'''
+
* '''Conda''' is a '''cross-platform package manager'''.
* '''Miniconda''' is a minimal installer for conda
+
* '''Miniconda''' is a minimal installer for '''conda'''.
* '''Conda''' installs, runs and updates the '''packages ''' and their '''dependencies'''
+
* '''Conda''' installs, runs and updates the '''packages ''' and their '''dependencies'''.
  
  
 
|-  
 
|-  
|| Show '''terminal '''and '''gedit '''text editor opened side-by-side
+
|| Show '''terminal '''and '''gedit '''text editor opened side-by-side.
 
|| Now, let us proceed with the installation.
 
|| Now, let us proceed with the installation.
 
|-  
 
|-  
 
|| '''gedit '''text editor''':'''
 
|| '''gedit '''text editor''':'''
  
Copy '''bash 1-install-Miniconda3-latest-Linux-x86_64.sh'''
+
Copy '''bash 1-install-Miniconda3-latest-Linux-x86_64.sh'''.
|| For installing '''Miniconda, '''copy the third command from the '''Code file.'''
+
|| For installing '''Miniconda''', copy the third command from the '''Code file'''.
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
Paste in the '''Terminal''' and press '''Enter'''
+
Paste it in the '''Terminal''' and press '''Enter'''.
|| Paste it in the '''terminal '''and press '''Enter.'''
+
|| Paste it in the '''terminal ''' and press '''Enter'''.
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
Press '''Enter '''several times
+
Press '''Enter ''' several times.
  
  
 
Point to '''More''' on the terminal.
 
Point to '''More''' on the terminal.
|| Press '''Enter''' several times to scroll through the '''Miniconda Licence '''page.
+
|| Press '''Enter''' several times to scroll through the '''Miniconda License ''' page.
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
Type '''yes '''and press '''Enter'''
+
Type '''yes ''' and press '''Enter'''.
||  
+
|| Type '''yes''' to approve the '''license terms''' and continue.
 
+
Type '''yes''' to approve the '''licence''' '''terms''' and continue.
+
 
+
 
+
  
 
|-  
 
|-  
Line 263: Line 266:
  
  
By '''default''', it will be installed in the user’s''' home directory.'''
+
By '''default''', it will be installed in the user’s''' home directory'''.
  
  
Line 269: Line 272:
  
  
I will go ahead with the '''default '''location.
+
I will go ahead with the '''default ''' location.
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Press''' Enter'''
 
Press''' Enter'''
|| Press '''Enter '''to confirm and proceed further.
+
|| Press '''Enter ''' to confirm and proceed further.
 
|-  
 
|-  
 
|| '''Terminal: '''
 
|| '''Terminal: '''
  
 
Type '''yes '''and press '''Enter'''
 
Type '''yes '''and press '''Enter'''
|| Type '''yes''' and press '''Enter''' to initialise '''Miniconda3 '''by running '''conda init.'''
+
|| Type '''yes''' and press '''Enter''' to initialise '''Miniconda3 ''' by running '''conda''' in it.
 
|-  
 
|-  
 
|| Point to the message.
 
|| Point to the message.
|| We can see a message notifying the successful installation of '''Miniconda.'''
+
|| 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
 
|| 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.
+
|| I will close the terminal and then reopen it by pressing the '''Ctrl''', '''Alt''' and '''T ''' keys together.
 
+
 
+
  
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
|| This step is necessary for the '''miniconda '''installation to take effect.
+
|| This step is necessary for the '''miniconda ''' installation to take effect.
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
|| Now we have to again navigate into the extracted '''Osdag installer folder.'''
+
|| Now we have to again navigate into the extracted '''Osdag installer folder'''.
 
|-
 
|-
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Type '''cd (space) Downloads''' and press''' Enter'''
 
Type '''cd (space) Downloads''' and press''' Enter'''
|| In the '''terminal''', I will type '''cd (space) Downloads''' and press''' Enter.'''
+
|| In the '''terminal''', I will type '''cd space Downloads''' and press ''' Enter'''.
 
|-
 
|-
||'''gedit '''text editor''':'''
+
||'''gedit '''text editor''':
  
 
Copy '''cd Osdag_ubuntu_installer_v2021.02.a.a12f'''
 
Copy '''cd Osdag_ubuntu_installer_v2021.02.a.a12f'''
||
+
||Copy the second '''command''' from the '''Code file'''.
 
+
 
+
 
+
Copy the second '''command''' from the '''Code file'''.
+
 
+
  
  
Line 315: Line 311:
 
||'''Terminal:'''
 
||'''Terminal:'''
  
Paste in the '''Terminal''' and press '''Enter'''
+
Paste in the '''Terminal''' and press '''Enter'''.
||
+
||Paste it in the '''terminal '''and press '''Enter'''.
 
+
 
+
 
+
Paste it in the '''terminal '''and press '''Enter.'''
+
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
|| Now let us proceed with the installation of '''Osdag.'''
+
|| Now let us proceed with the installation of '''Osdag'''.
 
|-  
 
|-  
 
|| '''gedit '''text editor''':'''
 
|| '''gedit '''text editor''':'''
  
 
Copy '''bash 2-install-osdag.sh'''
 
Copy '''bash 2-install-osdag.sh'''
 
 
  
 
|| For installing '''Osdag''', copy the fourth '''command''' from the '''Code file'''.
 
|| For installing '''Osdag''', copy the fourth '''command''' from the '''Code file'''.
 
 
  
 
|-  
 
|-  
Line 339: Line 327:
  
 
Paste in the '''Terminal''' and press '''Enter'''
 
Paste in the '''Terminal''' and press '''Enter'''
|| Paste it in the '''terminal '''and press '''Enter.'''
+
|| Paste it in the '''terminal ''' and press '''Enter'''.
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
Line 350: Line 338:
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
 +
|| By default,''' Osdag''' will be installed in the '''home directory'''.
  
  
 
+
We can confirm this by checking our specified''' installation directory'''.
|| By default,''' Osdag''' will be installed in the '''home directory.'''
+
 
+
 
+
We can confirm this by checking our specified''' installation directory.'''
+
 
|-  
 
|-  
|| Only narration
+
|| '''cd command'''.
 
+
|| Let us go to the '''home directory''' using the '''cd command'''.
 
+
 
+
|| Let us go to the '''home directory''' using the '''cd command.'''
+
 
+
 
+
  
 
|-  
 
|-  
Line 373: Line 353:
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
|| Now we are in the '''home directory.'''
+
|| Now we are in the '''home directory'''.
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
Type''' ls''' and press '''Enter'''
+
Type''' ls''' and press '''Enter'''.
|| Type '''ls '''and press '''Enter.'''
+
|| Type '''ls '''and press '''Enter'''.
 
+
 
+
  
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
Point towards '''miniconda3''' and '''Osdag''' directories
+
Point towards '''miniconda3''' and '''Osdag''' directories.
|| We see '''‘miniconda3’''' and '''‘Osdag’''' directories listed under the '''home directory.'''
+
|| We see '''‘miniconda3’''' and '''‘Osdag’''' directories listed under the '''home directory'''.
 
|-  
 
|-  
|| Only narration
+
||Cursor in the terminal.
|| We can also change the location of '''Osdag.'''
+
|| We can also change the location of '''Osdag'''.
  
  
 
To do so, simply move the '''Osdag''' directory to the preferred location.
 
To do so, simply move the '''Osdag''' directory to the preferred location.
 
|-  
 
|-  
|| Only narration
+
||Cursor in the terminal.
|| Let us now launch '''Osdag''' through the '''Terminal.'''
+
|| Let us now launch '''Osdag''' through the '''Terminal'''.
 
|-  
 
|-  
 
|| '''Terminal: '''
 
|| '''Terminal: '''
  
Type '''cd Osdag'''
+
Type '''cd Osdag'''.
|| To enter the '''Osdag directory''', type''' cd Osdag'''
+
|| To enter the '''Osdag directory''', type ''' cd space Osdag'''.
 
|-  
 
|-  
 
|| '''gedit '''text editor''':'''
 
|| '''gedit '''text editor''':'''
  
 
Copy '''python osdagMainPage.py'''
 
Copy '''python osdagMainPage.py'''
||  
+
|| To start '''Osdag''', copy the last '''command''' from the '''Code file'''.
 
+
To start '''Osdag''', copy the last '''command''' from the '''Code file.'''
+
 
|-  
 
|-  
 
|| '''Terminal:'''
 
|| '''Terminal:'''
  
 
Paste and press '''Enter'''
 
Paste and press '''Enter'''
||  
+
|| Paste the '''command '''in the '''terminal ''' and press '''Enter'''.
 
+
Paste the '''command '''in the '''terminal '''and press '''Enter.'''
+
 
|-
 
|-
 
||Only Narration
 
||Only Narration
 
+
|| It may take some time to open '''Osdag ''' for the very first time.
 
+
 
+
|| It may take some time to open '''Osdag '''for the very first time.
+
 
+
 
+
 
+
 
+
 
+
 
+
  
 
|-  
 
|-  
Line 433: Line 398:
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
|| Let us validate the installation by running a '''sample design example.'''
+
|| Let us validate the installation by running a '''sample design example'''.
 
|-  
 
|-  
 
|| '''Osdag:'''
 
|| '''Osdag:'''
  
 
Click on the '''Connection module'''
 
Click on the '''Connection module'''
|| Click on the '''Connection module '''present at the top left side.
+
|| Click on the '''Connection module ''' present at the top left side.
 
|-  
 
|-  
 
|| Click on '''Fin Plate''' image
 
|| Click on '''Fin Plate''' image
|| Click on the '''Fin Plate '''image to select the '''module.'''
+
|| Click on the '''Fin Plate ''' image to select the '''module'''.
 
|-  
 
|-  
 
|| Click on '''Start'''
 
|| Click on '''Start'''
|| Click on the '''Start button '''below to launch the '''module.'''
+
|| Click on the '''Start button ''' below to launch the '''module'''.
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
|| The '''module '''might take some time to launch.
+
|| The '''module ''' might take some time to launch.
 
|-  
 
|-  
 
|| '''Fin Plate Connection GUI:'''
 
|| '''Fin Plate Connection GUI:'''
  
 
Click on '''File''' '''Load input'''
 
Click on '''File''' '''Load input'''
|| Go to the '''File menu''' present at the top left corner, and select '''Load input.'''
+
|| Go to the '''File menu''' present at the top left corner, and select '''Load input'''.
 
|-  
 
|-  
 
|| '''Open Design Window:'''
 
|| '''Open Design Window:'''
  
 
Browse to the '''Code file directory'''
 
Browse to the '''Code file directory'''
|| I will browse to the '''Code file directory.'''
+
|| I will browse to the '''Code file directory'''.
 
|-  
 
|-  
 
|| '''Open Design Window:'''
 
|| '''Open Design Window:'''
  
Select the '''FinPlate_sample_design.osi '''file and click on '''Open'''
+
Select the '''FinPlate_sample_design.osi ''' file and click on '''Open'''
|| Select '''FinPlate_sample_design.osi, '''and  
+
|| Select '''FinPlate_sample_design.osi''', and  
  
  
Click on the '''Open button.'''
+
Click on the '''Open button'''.
 
|-  
 
|-  
 
|| Point toward the''' Input Dock fields'''
 
|| Point toward the''' Input Dock fields'''
 
|| We see the input values are populated for our '''sample design example'''.
 
|| We see the input values are populated for our '''sample design example'''.
 
  
  
 
|-  
 
|-  
|| Only narration
+
|| Cursor in the window.
 
|| We are now ready to perform the '''design'''.
 
|| We are now ready to perform the '''design'''.
 
|-  
 
|-  
Line 479: Line 443:
  
 
Click on the '''Design button'''
 
Click on the '''Design button'''
|| Click on the '''Design button '''at bottom to start.
+
|| Click on the '''Design button ''' at bottom to start.
 
|-  
 
|-  
 
|| '''Osdag:'''
 
|| '''Osdag:'''
  
Point towards the '''CAD window '''and the '''Log messages window'''
+
Point towards the '''CAD window ''' and the '''Log messages window'''.
|| Osdag will display the '''CAD model''' and print '''log messages.'''
+
|| Osdag will display the '''CAD model''' and print '''log messages'''.
 
|-  
 
|-  
|| Only narration
+
|| Point to the design.
|| This means that the '''design '''is complete.
+
|| This means that the '''design ''' is complete.
  
  
This indicates that the installation of '''Osdag '''is successful.
+
This indicates that the installation of '''Osdag ''' is successful.
 
|-  
 
|-  
 
|| Only narration
 
|| Only narration
Line 501: Line 465:
  
 
'''Summary'''
 
'''Summary'''
 +
|| In this tutorial, we have:
  
  
 
+
* Downloaded and installed '''Osdag''' on '''Ubuntu''' '''Linux operating system'''
|| In this tutorial, we have
+
 
+
 
+
* Downloaded and installed '''Osdag''' on '''Ubuntu''' '''Linux OS'''
+
 
* Opened '''Osdag '''through''' Terminal'''
 
* Opened '''Osdag '''through''' Terminal'''
 
* Verified the installation
 
* Verified the installation
Line 516: Line 477:
  
 
'''About Spoken Tutorial Project'''
 
'''About Spoken Tutorial Project'''
|| The video at the following link summarises the Spoken Tutorial Project
+
|| The video at the following link summarises the Spoken Tutorial Project.
  
Please download and watch it
+
Please download and watch it.
 
|-
 
|-
 
|| '''Slide:'''
 
|| '''Slide:'''
Line 526: Line 487:
  
  
For more details, please write to us
+
For more details, please write to us.
 
|-
 
|-
 
|| '''Slide:'''
 
|| '''Slide:'''
  
 
'''Answers for THIS Spoken Tutorial'''
 
'''Answers for THIS Spoken Tutorial'''
||Please post your timed queries in this forum
+
||Do you have questions in THIS Spoken Tutorial?
 +
 
 +
Please visit this website.
 +
 
 +
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.
 
|-
 
|-
 
|| '''Slide:'''
 
|| '''Slide:'''
  
 
'''FOSSEE Forum
 
'''FOSSEE Forum
||For any general or technical questions on Osdag, visit the FOSSEE forum and post your question
+
||For any general or technical questions on '''Osdag''', visit the '''FOSSEE''' forum and post your question
 
|-
 
|-
 
|| '''Slide: '''
 
|| '''Slide: '''
Line 549: Line 520:
  
  
Thanks for joining
+
Thanks for joining.
 
|-
 
|-
 
|}
 
|}

Latest revision as of 13:34, 25 May 2023

Title of the script: Installation of Osdag in Ubuntu

Author: Zahran Sajid

Keywords: Osdag, Installation, Ubuntu Linux, Terminal, Miniconda, sample design, Fin Plate, CAD model, conda, text editor, video tutorial.


Visual Cue 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 operating system
  • Open Osdag through Terminal
  • Verify the installation


Slide:

System Requirements

To record this tutorial, I am using:
  • Ubuntu Linux 20.04
  • Osdag version 2021(v2021.02.a.a12f)
  • gedit text editor, and
  • A working internet connection
Slide:

Pre-requisites

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 link.
  • 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 the 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 operating system 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.
Cursor in the Osdag page. 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.

Cursor in the form. 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.
Cursor in the Terminal window. Here on wards, 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 is 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 it 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 License page.
Terminal:

Type yes and press Enter.

Type yes to approve the license 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 in it.
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.

cd command. 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.
Cursor in the terminal. We can also change the location of Osdag.


To do so, simply move the Osdag directory to the preferred location.

Cursor in the terminal. Let us now launch Osdag through the Terminal.
Terminal:

Type cd Osdag.

To enter the Osdag directory, type cd space 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.


Cursor in the window. 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.
Point to the design. 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 operating system
  • 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

Do you have questions in THIS Spoken Tutorial?

Please visit this website.

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.

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.

Contributors and Content Editors

Anandajitht, Danish, Madhurig