diff --git a/docs/tutorials.rst b/docs/tutorials.rst index cf9e15ffc..1b5520ce3 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -81,11 +81,20 @@ This will install all the dependencies required for running of the tutorials. $ sudo apt-get install libx11-dev libxext-dev libxfixes-dev libxi-dev -Now, just go into the _../MSS/tutorials/_ directory :: +Now, just go into the **../MSS/tutorials/** directory :: $ cd ../MSS/tutorials/ +**Note** + +You must go into the tutorials directcory and then run the .py files. And always remember to add the PYTHONPATH to +........../MSS/ directory. +You cannot just do like this :: + + $ python MSS/tutorials/sreenrecorder.py # This will be problematic. + + In Linux for making the cursor visible as a highlighter, perform the following ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ If you are in Windows, there is no need of this highlighter. It is by default that it also records the mouse-pointer. @@ -113,7 +122,7 @@ Each python file inside MSS/tutorials can be run directly like :: (mssdev)~/..MSS/tutorials/ $ python screenrecorder.py -For recording anything on your screen. The videos will be then saved to `MSS/tutorials/Screen Recorders/` +For recording anything on your screen. The videos will be then saved to `MSS/tutorials/Screen Recordings/` For all the tutorials, you can do the same, example :: @@ -122,7 +131,7 @@ For all the tutorials, you can do the same, example :: (mssdev)~/..MSS/tutorials/ $ python tutorial_hexagoncontrol.py The `MSS/tutorials/textfiles` contain descriptions of the tutorial videos in text format, these later can be -converted to audio files by `audio.py` script after adding certain #ToDOs. +converted to audio files by `audio.py` script after adding certain #ToDOs there. **Note** In tutorials development, when creating a class of Screen Recorder as :: diff --git a/tutorials/textfiles/tutorial_kml.txt b/tutorials/textfiles/tutorial_kml.txt new file mode 100644 index 000000000..6e66ff7cd --- /dev/null +++ b/tutorials/textfiles/tutorial_kml.txt @@ -0,0 +1,48 @@ +The MSS software will be maximised automatically and TOP VIEW will be opened. + +After clicking on SELECT TO OPEN CONTROL, click on KML OVERLAY. The UI will look as shown. + +The GREEN coloured boundary is the KML file that denotes the geographical boundary which helps in planning the WAY POINTS. + +We can put the WAY POINTS along this green line. We will now see how to add, move, select KML files. + +We can see two KML files here, one is COLOR.KML ; and the another one is FOLDER.KML. + + +COLOR.KML is in Red colour, FOLDER.KML is denoted by Green colour. + +The box is checked that shows that these KML files are shown in the map, if unchecked, it will not show. + + +First of all, we click on SELECT ALL FILES, and then click on REMOVE FILES. Both the KML files will be removed. + +Now, we will add KML files by clicking on ADD KML FILES. The dialogue will be opened and it will add the path where the KML file is present. You can also select it through the file dialogue. + +When we add a KML file, the default colour is Black and the default linewidth is 5 units. + +Now, let's change colour and line width of the KML files. Before that, we add another KML file. Both the KML files will be opened when we will open the GLOBAL map. + +Both the files are in black colour. + +Now, we will change colour of FOLDER.KML file by selecting it and clicking on CHANGE COLOUR. We change it from Black to blue followed by blue to green. + +Changing it for some time... + +Now, we change line width by changing its numerical value whose range is 0 to 10. + +We change it to different values to obtain different linewidths. + + +After entering in GLOBAL MAP, we can see COLOR dot KML file which is in black colour. + +We change its colour by clicking on CHANGE COLOR option button. + +We change it to Red. + +It's default line width is 5. + +We again change its colour to Maroon. + +We type the line width to 6.53 and then 3.45. + +The top view is closed and the tutorial ends. diff --git a/tutorials/textfiles/tutorial_mscolab.txt b/tutorials/textfiles/tutorial_mscolab.txt new file mode 100644 index 000000000..850be9a30 --- /dev/null +++ b/tutorials/textfiles/tutorial_mscolab.txt @@ -0,0 +1,199 @@ +mission support collaboration + +MS Colab stores data in an online server, and can be used to access the data remotely as also working in a team where everyone contributes his part. It is used for collaborating with the users as a team together and working on a shared MScolab project. + + +to start with, click on Connect to MS Colab, + +in the window opened, enter MSColab url and click on connect. + +"successfully connected to the ms colab server" + + +we can enter Email id and Password for an existing user, else we can click on Add user to register a new user. + + +Filling new user Details, and clicking OK. + +As, the user exists, we go back to cancel and enter the login page again! + +logging into my profile by entering my user name and password. + +Then clicking on the login button. + +Now the user John Doe is logged in to MScolab. + +He can now start working on shared project. + +go to File and then new and then M S Colab Project option. + +Add mscolab project + +MSS project window opens + + +name the path, give the Description of the project. + + +we can also choose a flight track file or dot FTML file, which is stored on our computer. + +Add project by clicking OK. + + +"your project was successfully created" + + +Double click on the shared project name to activate it. + + +while working on a shared file, we can control who can access this project. + +go to Project and then, "Manage Users." + +Admin Window-MSS pops up. + +the left side has list of users without permission, while the right side has a list of those users who have been granted an access to this project. + + +In All Users without permission section, we can select all users at a time or deselect all of them, or we can search for a user. + +We search for the user "test" in the server. + +Now we empty the search bar. + +After selecting users, we click on Add button, which moves these users to All users with permission section to the right side of the window. + + +for the users who have access permission to the project, we can also change the access roles. + +Here for b, we have changed the permission from collaborator to admin. + +we can alo delete a user with a permission by selecting user and clicking on delete button. + + +Changing their access roles.... + + +we can filter users based on their roles being Collaborator, admin or viewer. + + +Filtering for some time.... + + +We can also communicate with fellow users in our project. + + +go to Project and then Chat option. + +Click on it. + +MsColab chat window pops up. + +the left pan shows the list of people who have access to this project. + + +enter the message in the space provided. + +Typing the texts..... + +click on send button, or press Enter. + + +Typing another message.... + + +we can upload files by clicking on upload and browsing for the file. + + +Here, we send the mss logo to all the users to see. + +we can also search for a meassage by entering a phrase or complete text and then pressing previous or next as we need to find the message. + + +Next, we close the chat window. + +Now, we will see how to manage version history. + +We will go to projects and then click version history.. + +Version history is basically a record in the changes performed in the waypoints of the flight track. + +We can switch to a particular version history and name that version according to our choice or just checkout to that version. + +In that case, the current waypoints will be changed to that version of waypoints and their locations. + + +Now we will just surf through all the version history. + + +We change the name of one version history to "Initial Waypoints" by clicking on "Name Version" + +Now, we select another waypoint version and then checkout to that version by clicking on checkout button. + +It asks for a confirmation. + +Now we close the version history window... + +We then select work asynchronously checkbox. It means that we are offline at present. + +Later, we can save our changes to server or fetch new changes from the server changed by other people or the changes present on the server the last time. + +We then open topview and move the waypoints for making changes... + +We then open drop down menu of "save to server." + +It will open a window. + +We can either click overwite server waypoints with local waypoints or local waypoints with server waypoints. + + +We click overwite with local waypoints. + +The server waypoint changes with the work we have done locally. + +Now it gives a confirmation message. "Added local waypoints to server" + +Now we will close the window. + +We will again start work synchronously with other users by unchecking "Work Unsynchronously." + +We can switch between local flight tracks and shared project by double clicking any one of them. + +Remember, at any point only one flight track can be active, either local or shared. + +Now we make changes in the topview of local flight track. + +Opening topview and making the changes.... + +Adding waypoints.... + + +We can see new waypoints are added here in a different fashion. + +It is different from the first set of waypoints we have selected and added. + +We now close the topview. + +The local flight track got changed. + + +Now for confirming, we open the shared flightrack by activating it. + +We open topview and can see it is different form local flightrack. + +We now close the topview and answer the confirmation. + + +We now delete the project. + +We have to retype its name for the confirmation for deleting it. + +Now, we click on John Doe's User profile and we select the Profile of the user. + +We can see his email and server its connected to! + +Now, we log the user out. + +We close the MScolab window and it asks for confirmation. + +This is all about MScolab. diff --git a/tutorials/textfiles/tutorial_views.txt b/tutorials/textfiles/tutorial_views.txt new file mode 100644 index 000000000..1cc57d661 --- /dev/null +++ b/tutorials/textfiles/tutorial_views.txt @@ -0,0 +1,129 @@ +Lets look at the tutorial of the various views required for flight planning: top view, side view, linear view and table view. + + +At first, lets open top view and side view. + +Now we will take some time to relocate it properly for a better visibility. + + +Now we will add some way points to plan the flight track. + + +As we make changes in the top view, simultaneously changes are also made in the side view, table view and linear view. + + +Basically, the different views are just different ways to showcase the same data from different perspectives. + + +Flight moves from Nagpur to Delhi to waypoint number 2 to waypoint number 3 and so on. + + +Then look at the web map service to check whether the way points chosen are correct. We are going to improvise the flight track with wms. + + +In the wms, we will open the server layer and click "select layer" list. + + +Then through open-mss dot org we will derive the layer list and load the capabilities. + + +Now the layer list is loaded and we drag it down just to create some space. + + +Now we will select different layers : divergence, equivalent potential temperature, relative humidity, etcetera. + + +Now while changing the levels, we can see the map at 250 hPa relative humidity, initialized from 17/10/2012 valid till 18/10/2012. + + +Based upon the analyzation on the map, we can change the waypoints like we can drag waypoint 5 downwards. + + +Thus wms helps us in analyzing and planning the way points on the map and plan the flight tracks flawlessly. + + +The wms layer list is different for top view and side view. + + +In the top view we can see various layers of pressure. + + +Similarly, now we click on the side view layer list and derive data from open-mss dot org. + +Click on cloud cover vertical section and we can see blue clouds on the side view map. + + +Similarly, we can see horizontal wind, specific humidity, temperature and so on. + + +We can move the way point of Delhi to higher pressure say 450, move way point 3 to 550, way point 5 to 400, directly add way point 2 to 400, move way point 4 to 380 and so on. + + +Now lets close the layer list and open table view and enter the latitudinal and longitudinal data and simultaneously see changes in the top and side view. + + +We can click on way point 2 and it has list of options to select in the naming of the waypoints. + + +Suppose we select Juelich, the latitude and longitude gets changed accordingly. + +Now we can name way point 3 as Brindisi Location A and way point 4 with user defined name Stop Point. + + +In this case the latitude and longitude remains the same, only the way point gets named. + + +In this table we can directly enter the values. + + +For example, in brindisi location A, the latitude remains the same and by changing the longitude value we can create a new way point. + + +Similarly, we can add comments to way point 9. + + +To insert a new way point, we can just click on sixth row and then insert and a completely new way point is created below way point 6. + + +Simultaneously, we can see the top view and side view also gets changed. + + +Click on the delete option to delete way point 10. + + +Clicking on reverse, the entire direction of flight track gets reversed. + +Way point 0 now appears on the place of way point 11 and way point 11 appears on the place of way point 0. + + +Now lets close the table view and open linear view and see simultaneous changes in linear and side view. + + +In linear view, we see linearly how the flight profile gets changed with the change in latitude and longitude. + + +Linear view also has its own wms and layer list and we derive the layer list using open-mss dot org and retrieve the capabilities present in this layer. + + +Select horizontal wind and we can see the difference of horizontal wind at various way points denoted by lines. + + +Similarly we will select other layers and see its graphical presentation on the linear view. + + +In linear view we can only see the graphical representations of layer list data. + +To add or delete way points we have to use the top or side views. + + +Finally we close the linear view. + +Now closing the side view.... + + +Now closing the top view.... + +Lastly, closing MSS... + + +This is how we can make use of the various views to plan a flight track. diff --git a/tutorials/textfiles/tutorial_wms.txt b/tutorials/textfiles/tutorial_wms.txt new file mode 100644 index 000000000..be0f241e6 --- /dev/null +++ b/tutorials/textfiles/tutorial_wms.txt @@ -0,0 +1,86 @@ +Hello folks! Today we will learn what is WMS or web map service. + + +Suppose we are planning our flight track, so to determine the suitable flight path there are various parameters and one such indispensable parameter is wms that shows weather reports or various meteorological data in the entire map. + + +So, lets start the tutorial to know what is wms in depth. + + +When we open the top view of the map, the web map service is already opened by default. + +It collects its data from the server: "open-mss.org" that provides all the meteorological or atmospheric informations as layer lists. + + +As we click on the server layer option, the layer list window opens that lists out various layers. + + +We just have to enter the wms url and get capabilities or those layers. + + +So, here we find various layers: Divergence and Geopotential Height, Equivalent potential temperature and geo potential height, etc. When we click on the divergence layer, some divergence in height that are marked by blue and red lines are displayed. + + +Similarly, when we move on to the equivalent temperature potential layer, we find various temperature potentials at various places on the map. + + +We can also customize the levels, that is, the pressure levels after selecting a particular layer. + + +As we enter temperature in layer filter, all the relevant layers related to temperature are displayed. + + +In multilayering, we can see more than one layers such as temperature and pressure together at the same time displayed onto the map. + + +Just check on multilayering and then select divergence and geo potential height as well as vertical velocity and geo potential height and we can find both the layers at the same time on the map. + + +Now lets uncheck multilayering and come to starred layer. + + +Suppose we are using any layer frequently, we can just star it and find it easily using layer filter. + + +Now coming to vertical velocity, we can check the map at various atmospheric pressures such as at 150 hPa or 200 hPa or 500 hPa. + + +Initialisation shows the date and time from which the data is available. Here it is 17/10/12. +Valid shows the date and time till the data available is valid. + + +Here it is 17/10/12 and time is 12:00 UTC. + + +We can customize these points as per our requirement. + + +We can select the various initialization and valid interval slots as per availability. +For example, when we select 3 hours initialization time, we can see the date and time marked crossed as there is no such initialization time ahead or back. + + +Similarly, when we select 6 hours valid time we can see the time changes to 18:00 UTC. + + +Coming to the auto-update, if it is checked then whatever is selected on the list gets updated on the map automatically. + + +If the auto update option is not checked then we have to press retrieve after each selection on the layer list. + + +If we select "use cache" as checked, then it takes less time to load the data from layer list on the map but if its unchecked it takes more time to load. + + +We can also click on clear cache to clear the cache that is stored locally for the layer lists data. + + +There is a delete button on the top left corner of the layer list to clear all the layers loaded from the server. + + +Clicking on remove deletes the layer data on the map. + +Now we close the wms layer list window. + +And then the topview window. + +Finally, closing the MSS main window.