[pyorbit] description

[J.W. Bizzaro]

Justin Bradford wrote:
> 
> How would you feel about holding off until I have something going?

Okay by me.

> Also, are there any issues for setting up a CVS account for pyORBit?

The way CVS is set up now, anyone with a shell account at theopenlab can make a
new module.  But one must have an account: there is no anonymous access, which
we may want to change in a little while.  Also, the new module directory needs
to be set to the ownership of group 'cvs', and permissions need to be set to
group read/write.  For example, if you made a new module, the ownership would be
justin.justin.  We would have to change that to justin.cvs so that others in the
cvs group can contribute.  As soon as you make the module, let me know an I'll
make the changes.

FYI, I copied some CVS instructions below.  Item (9) talks about making a new
module.

  (1) Set the environment variable.  <username> is your shell account
      user name.  For bash, use

        $ export CVSROOT=':pserver:<username>@theopenlab.uml.edu:/home/cvs'

      For csh, use

        $ setenv CVSROOT ':pserver:<username>@theopenlab.uml.edu:/home/cvs'

  (2) Login.

        $ cvs login

      CVS will ask for your password.  This will be your shell account pw.

  (3) To "checkout" a module, use the command by the same name.

        $ cvs checkout <modulename>

      This will create a directory called ./<modulename> (within the pwd)
      with everything in it.

  (4) You can cd to the new directory and make whatever changes you want.

  (5) When you add or remove a file, you need to notify CVS.  Let's say you
      created a README file.

        $ cvs add README

  (6) Once you have finished working in the directory, commit the changes.

        $ cvs commit

      This will commit everything in the pwd, since no specific file was
      specified.  You can also specify a file.

  (7) Newer versions of CVS support logouts.

        $ cvs logout

  (8) You can start all over again at a later time, but it is likely
      the module will have been changed by someone else.  In the
      directory where you created the <modulename> directory, rename
      <modulename> to something else (say "<modulename>-old") if you
      want to keep it.  Otherwise typing "cvs checkout <modulename>"
      may change some things.  If you want to update the copies of the
      files you have, you can use the "update" command.

        $ cvs update <filename>

      Remember that the checkout command is used in the parent directory
      to the <modulename> directory.  The other commands are used within
      the <modulename> directory itself.

  (9) You can also make a new module with the "import" command.

        $ cvs import -m "<message about import>" <modulename> <branchname>
<tagname>

      Note that the -m option lets you put in a message without starting
      an editor.  Otherwise CVS will start up $EDITOR.

  (10) If you would like to see a list of the cvs commands, you can use the
       "help" command.

         $ cvs help



Cheers.
Jeff
-- 
                         +----------------------------+
                         |        J.W. Bizzaro        |
                         |  jeff at theopenlab.uml.edu   |
                         |                            |
                         |        THE OPEN LAB        |
                         | Open Source Bioinformatics |
                         |                            |
                         | http://theopenlab.uml.edu/ |
                         +----------------------------+