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:

toolbox/ep : equilibrium continuation, totorial in help/ep/EP-Tutorial.pdf
toolbox/core : toolbox development in COCO, short reference in help/core/COCO_ShortRef.pdf
examples/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.