[go: up one dir, main page]
Menu ▾ ▴

Tree [r2930] / cocotools / coco2 /
 History

HTTPS svn://
HTTPS access

File Date Author Commit
 coll 2015-10-30 hdankowicz [r2930] updated and added Content files
 continex 2015-10-16 fschild [r2917] fixes to continex
 core 2015-10-30 hdankowicz [r2924] moved reference to help and reverted to previou...
 covering 2015-10-16 fschild [r2916] added note about where to find log_angle code
 ep 2015-10-30 hdankowicz [r2930] updated and added Content files
 help 2015-10-30 hdankowicz [r2926] added tutorial and reference files
 po 2015-10-30 hdankowicz [r2930] updated and added Content files
 recipes 2015-10-27 hdankowicz [r2923] deleted dummy calculation
 LICENSE.txt 2015-03-05 fschild [r2839] ****** Reorganised repository layout. ******
 README.txt 2015-10-30 hdankowicz [r2929] updated README
 coco_project_opts.m 2015-10-27 hdankowicz [r2921] added coco_projects_opts.m to top level
 startup.m 2015-03-05 fschild [r2839] ****** Reorganised repository layout. ******

Read Me

This is a summary of the instructions found at
<https://sourceforge.net/p/cocotools/wiki/installation/>.

Installing and using COCO
=========================

1. Download the latest version from <https://sourceforge.net/projects/cocotools/files/latest/download>.

2. Move the package file to a location of your choice and uncompress the zip-file. This will create a sub-directory with name coco that contains all files and will be referred to as PATH_TO_COCO in the remainder of these instructions.

3. Change to the Matlab startup directory for your system (any folder returned by the Matlab-function 'userpath'). Create or open the file startup.m and add the line

	run PATH_TO_COCO/startup

where PATH_TO_COCO is the full path of the directory coco created in step 1.

4. Copy or move the file PATH_TO_COCO/coco_project_opts.m to the Matlab startup directory (the directory where the startup.m file created or modified in step 2 is located).

   Note: Do not add PATH_TO_COCO to the Matlab path!

5. After restarting Matlab, all coco toolboxes should now be in the search path.

Documentation
=============

In the current version, tutorials are available for the following toolboxes and examples:

ep      : continuation of equilibrium points--examples in ep/examples/, tutorial documentation in help/EP-Tutorial.pdf
coll    : continuation of constrained collections of trajectory segments--examples in coll/examples/, tutorial documentation in help/COLL-Tutorial.pdf
po      : continuation of periodic orbits in smooth and hybrid dynamical systems--examples in po/examples, tutorial documentation in help/PO-Tutorial.pdf
core    : core utilities--short reference in help/COCO_ShortRef.pdf
recipes : collection of examples from the book Recipes for Continuation, Society for Industrial and Applied Mathematics (SIAM), 2013. Use the Matlab-command 'doc recipes' to browse its contents.