| 1 | TODO: installation and setup and howto develop instructions for someone whos never used it |
|---|
| 2 | explain ./manage |
|---|
| 3 | define what functionality is in which files |
|---|
| 4 | |
|---|
| 5 | add refresh status of nodes |
|---|
| 6 | remove passwords from url -> put in SESSION variable |
|---|
| 7 | add ip and which node is running |
|---|
| 8 | choose which node to start domain manager on |
|---|
| 9 | pick the nodeBooter from dev/nodes/ |
|---|
| 10 | installation paragraph for local server |
|---|
| 11 | ############# |
|---|
| 12 | Django setup |
|---|
| 13 | ############# |
|---|
| 14 | There are 4 main applications in the project: LoginUser, WebDash, HtmlPages, and DomainMan |
|---|
| 15 | LoginUser: handles logging in the user, redirecting pages, and user directory/accounts/waveforms |
|---|
| 16 | WebDash: controls the waveforms |
|---|
| 17 | HtmlPages: the main pages for the interface |
|---|
| 18 | DomainMan: Connecting to nodes and starting nodeBooter/naming service |
|---|
| 19 | |
|---|
| 20 | ######## |
|---|
| 21 | Settings |
|---|
| 22 | ######## |
|---|
| 23 | Once the project is checked out from the repository, there is no need to change between the settings for the webserver and working directory |
|---|
| 24 | This is handled in the apache/django.wsgi file: the webserver looks at settingsWeb.py |
|---|
| 25 | and the working directory uses the default settings.py when using the development server (python manage.py runserver) |
|---|
| 26 | |
|---|
| 27 | ############ |
|---|
| 28 | Static files |
|---|
| 29 | ############ |
|---|
| 30 | After changing the css or javascript files, you must run (python manage.py collectstatic) to update the main /static folder. |
|---|
| 31 | Make sure that the directorys where the original file is located is also listed in the STATICFILES_DIRS of the settings file. |
|---|
| 32 | |
|---|
| 33 | Ossie interface layout |
|---|
| 34 | ====================== |
|---|
| 35 | Four main frames are separated into four div tags: the directory, the main frame, the workspace, and the active applications. |
|---|
| 36 | #Directory: lists the waveforms of the loaded node, |
|---|
| 37 | #Main frame: contains the status of the nodes in a grid or map form |
|---|
| 38 | #Apps: Lists the waveforms that are running |
|---|
| 39 | #Workspace: contains the information about the current waveform |
|---|
| 40 | |
|---|
| 41 | ######### |
|---|
| 42 | LoginUser |
|---|
| 43 | ######### |
|---|
| 44 | The login runs on SQLite database file found in the main directory saved as cornetApps.db |
|---|
| 45 | This is separate from the CORNET user database. |
|---|
| 46 | It runs through the given Django login module (django.contrib.auth.views.login). |
|---|
| 47 | |
|---|
| 48 | ######### |
|---|
| 49 | DomainMan |
|---|
| 50 | ######### |
|---|
| 51 | Connects to the ip's of the nodes: 192.168.1.xx. |
|---|
| 52 | .xx starts at 11 on floor 1 and increments by 1. Each floor has 12 nodes: |
|---|
| 53 | Floor 1: .11 - .22 |
|---|
| 54 | Floor 2: .23 - .34 |
|---|
| 55 | Floor 3: .35 - .46 |
|---|
| 56 | Floor 4: .47 - .58 |
|---|
| 57 | |
|---|
| 58 | When connecting through the server, see http://cornet.wireless.vt.edu/trac/wiki/CORNET/HowToUseCORNET |
|---|
| 59 | |
|---|
| 60 | ################## |
|---|
| 61 | Using the interface |
|---|
| 62 | ################### |
|---|
| 63 | |
|---|
| 64 | When clicking on the node in the interface, it calls the loadNode(ip) javascript method, |
|---|
| 65 | which in turn loads the waveform through WebDash into the #directory div/frame. |
|---|
| 66 | |
|---|
| 67 | In the directory column/frame, the home icon brings the user to the account page where you can view the user's available waveforms. |
|---|
| 68 | the eject icon logs the user out of the interface. |
|---|
