CDS 270: Information for Lecturers: Difference between revisions

From Murray Wiki
Jump to navigationJump to search
No edit summary
 
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{cds270-2 header}}
{{righttoc}}
This page is intended for use by people giving lectures in [[CDS 270-2|CDS 270-2, Networked Control Systems]].  It contains information on what is expected for each set of lectures and directions for how to use the wiki to document your lectures.
This page is intended for use by people giving lectures in [[CDS 270-2|CDS 270-2, Networked Control Systems]].  It contains information on what is expected for each set of lectures and directions for how to use the wiki to document your lectures.


Line 13: Line 13:
== Wiki Page ==
== Wiki Page ==


For each lecture, a wiki page should be set up that documents the material presented in the lecture.  Each lecture page should contain the following information:
For each lecture, a wiki page should be set up that documents the material presented in the lecture.  The title of the wiki page should be of the form "NCS: <topic>", where <topic> is a short phrase describing the topic of the lecture (eg, Receding Horizon Control).  Each lecture page should contain the following information:
* An abstract summarizing what the lecture is about and including key terms so that the pages can be located using the wiki search engine.
* An abstract summarizing what the lecture is about and including key terms so that the pages can be located using the wiki search engine.
* A copy of the lecture presentation, in PDF format.  These should be posted no later than the evening in which the lecture is given.
* A copy of the lecture presentation, in PDF format.  These should be posted no later than the evening in which the lecture is given.
Line 20: Line 20:
* Links to additional information.  If there are good sources of additional information for students interested in exploring this topic further, these should go at the bottom of the page.
* Links to additional information.  If there are good sources of additional information for students interested in exploring this topic further, these should go at the bottom of the page.
An example of this type of page is the [[NCS: Introduction]] lecture page.
An example of this type of page is the [[NCS: Introduction]] lecture page.
To create wiki page for a lecture, you can use the [[:Template:CDS 270-2 Lecture|CDS 270-2 lecture template]].  The easiest way to do this is to follow these steps:
<ol>
<li> On the [[CDS 270-2|CDS 270-2 Main Page]], go to the [[CDS 270-2, Spring 2006#Course Schedule|course schedule]] and edit the table.
<li> Create a new link in the last column for the lecture you will be giving, with the text <nowiki>"[[NCS: <topic>]]"</nowiki> and save the page.
<li> This will create a link to your new page (which should be in red unless that page already exists).  Click on that link.
<li> In the editing box for the page, enter the following text
<pre>{{subst:CDS 270-2 Lecture}}</pre>
and save the page.  This will insert the lecture template that has all of the right sections in it.
<li> Edit the page and fill in the sections as described in the comments
</ol>
<p>
<font color=red>Note: when you first create a page, the header information (which lets you move to previous and next lectures) will not be initialized properly.  Send e-mail to [mailto:murray@cds.caltech.edu|Richard] and he will fix them up.</font>  (For experts: you need to create the templates <nowiki>'{{PAGENAME}} Previous' and '{{PAGENAME}} Next'</nowiki> and then purge the page.)
</p>
== Book Chapter ==
For each module, a 10-20 page chapter should be created that students can use as a reference for the material.  These chapters are intended to form the first iteration of a textbook for networked control systems.  The book will be formatted using latex and made available to students as PDFs via the course wiki.
To create a chapter in the book, you first need to check out a copy of the book from the CVS repository.  Full instructions for doing this are available from the [https://www.cds.caltech.edu/help/cms.php?op=faq&faq_op=show_cat&cat=15 CDS help page]:
<ol>
<li> Login to the repository using the CDS CVS server
<pre>
cvs -d :pserver:lastname@cvs.cds.caltech.edu:/home/users/murray/cvs_roots/books login
</pre>
When prompted for your password, enter your first name (lower case).
<li> Checkout the book from the repository, using your last name (lower case) as the user name:
<pre>
cvs -d :pserver:username@cvs.cds.caltech.edu:/home/users/murray/cvs_roots/books checkout ncs06
</pre>
This should create a directory 'ncs06' with the current contents of the book.
</ol>
Read the README file in the ncs06 directory for information on how to compile the book and how to add a chapter.
== Application Lectures ==
For lectures that are focused on one of the course applications (Alice and RoboFlag), the same instructions should be used for creating a wiki page, except that the page name should be of the form <nowiki>[[Alice: <topic>]]</nowiki> or <nowiki>[[RoboFlag: <topic>]]</nowiki>.  The intent of using a different page naming convention is two fold: (1) allowing the style of these pages to be different than the standard NCS lecture and (2) allowing possible use of these pages for different courses that are not linked to CDS 270-2.

Latest revision as of 05:43, 3 April 2006

This page is intended for use by people giving lectures in CDS 270-2, Networked Control Systems. It contains information on what is expected for each set of lectures and directions for how to use the wiki to document your lectures.

Course Module

A course module consists of 3 lectures given over the course of a week. Each module consists of the following materials:

  • A set of three lectures in powerpoint (or PDF) format that could be posted on the web
  • A wiki page for each lecture summarizing the material and including references to related work
  • A 10-20 page "chapter" that would be part of the "textbook" for the class
  • Some optional homework exercises that interested students could undertake

When appropriate, the third lecture should be an "application" lecture in which the use of the concepts is described in the context of one of the course testbeds (Alice or RoboFlag). This is especially important in the first few weeks of the course, when the basic ideas and challenges are being introduced.

Wiki Page

For each lecture, a wiki page should be set up that documents the material presented in the lecture. The title of the wiki page should be of the form "NCS: <topic>", where <topic> is a short phrase describing the topic of the lecture (eg, Receding Horizon Control). Each lecture page should contain the following information:

  • An abstract summarizing what the lecture is about and including key terms so that the pages can be located using the wiki search engine.
  • A copy of the lecture presentation, in PDF format. These should be posted no later than the evening in which the lecture is given.
  • A copy of the notes for the lecture, in PDF format. Homework exercises should be included in the notes. (This can be omitted if the material is very standard and an online set of notes is already available.)
  • A reading list for the lecture. This will typically be 3-5 articles or book chapters that are particularly relevant to the material being presented. The reading list should be annotated to explain how the articles fit into the topic for the lecture.
  • Links to additional information. If there are good sources of additional information for students interested in exploring this topic further, these should go at the bottom of the page.

An example of this type of page is the NCS: Introduction lecture page.

To create wiki page for a lecture, you can use the CDS 270-2 lecture template. The easiest way to do this is to follow these steps:

  1. On the CDS 270-2 Main Page, go to the course schedule and edit the table.
  2. Create a new link in the last column for the lecture you will be giving, with the text "[[NCS: <topic>]]" and save the page.
  3. This will create a link to your new page (which should be in red unless that page already exists). Click on that link.
  4. In the editing box for the page, enter the following text
    {{subst:CDS 270-2 Lecture}}

    and save the page. This will insert the lecture template that has all of the right sections in it.

  5. Edit the page and fill in the sections as described in the comments

Note: when you first create a page, the header information (which lets you move to previous and next lectures) will not be initialized properly. Send e-mail to [1] and he will fix them up. (For experts: you need to create the templates '{{PAGENAME}} Previous' and '{{PAGENAME}} Next' and then purge the page.)

Book Chapter

For each module, a 10-20 page chapter should be created that students can use as a reference for the material. These chapters are intended to form the first iteration of a textbook for networked control systems. The book will be formatted using latex and made available to students as PDFs via the course wiki.

To create a chapter in the book, you first need to check out a copy of the book from the CVS repository. Full instructions for doing this are available from the CDS help page:

  1. Login to the repository using the CDS CVS server
    cvs -d :pserver:lastname@cvs.cds.caltech.edu:/home/users/murray/cvs_roots/books login
    

    When prompted for your password, enter your first name (lower case).

  2. Checkout the book from the repository, using your last name (lower case) as the user name:
    cvs -d :pserver:username@cvs.cds.caltech.edu:/home/users/murray/cvs_roots/books checkout ncs06
    

    This should create a directory 'ncs06' with the current contents of the book.

Read the README file in the ncs06 directory for information on how to compile the book and how to add a chapter.

Application Lectures

For lectures that are focused on one of the course applications (Alice and RoboFlag), the same instructions should be used for creating a wiki page, except that the page name should be of the form [[Alice: <topic>]] or [[RoboFlag: <topic>]]. The intent of using a different page naming convention is two fold: (1) allowing the style of these pages to be different than the standard NCS lecture and (2) allowing possible use of these pages for different courses that are not linked to CDS 270-2.