CapCode-software suite for sailors Files

Capcode, a free navigation suite for sailors under a GNU GPL Licence.
Version 0.9.4 beta

1) LICENCE

2) IMPORTANT NOTICE

3) NOTES

4) CHANGE LOG

1) LICENCE
a copy of the GNU GPL licence can be obtained at:
www.gnu.org/copyleft/gpl.html

2)IMPORTANT NOTICE
You acknowledge that using this software for the purpose of navigation does not
engage the authors responsabilities in case of damage, injuries or casualities due
to the use of this software.
This software MUST NOT BE USED as a means of navigation, weather prediction, 
tide and currents prediction or any other critical sailing activities as it was 
not developed for that purpose.
Capcode, a free software suite for sailor is in any cases NOT a certified software.
Use of this software is done at your own risks. 
The maps provided with your copy of capcode are not accurate or are obsolete.
They have been made with the built-in editor 
or copied from NOAA web site as a support for demonstration. 
In no case you should use these maps as a support for your navigation.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

-Redistribution of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

-Redistribution in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

-The source code is available at sourceforge.net under the project capcode.

- Neither the name of "Capcode a free software suite for sailor" or the names
 of authors may be used to endorse or promote products derived from this 
 software without specific prior written permission.

- This software is provided "AS IS," without a warranty of any kind. ALL
EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
NON-INFRINGEMENT, ARE HEREBY EXCLUDED. CAPCODE AND ITS
LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A
RESULT OF USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES.

IN NO EVENT WILL "CAPCODE A FREE SOFTWARE FOR SAILORS" OR ITS LICENSORS 
BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, 
CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND REGARDLESS 
OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, 
EVEN IF THE AUTHORS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

3) NOTES
Installation:
For linux:
download the capcode_0_9_4_beta.tar.gz
untar it anywhere, but remember where
go to the folder where capcode was untared
find capcode.sh
in console mode: ./capcode.sh
in graphical file explorer: double-click on capcode.sh

For windows
download capcode capcode_0_9_4_beta.zip
unzip it anywhere, but also don't forget where. I would suggest in c:\capcode...
select the folder (let's say c:\capcode)
double click on capcode.exe (or capcode_c.exe if you want to have a console and trace the debug display)

languages:
capcode is available in French and English (Other languages may be available in the future)
we are looking for people interested in doing the translation job. 
Knowledge required: your mother language.

functions:
- layers: internal windows in capcode are organised in layers. You can bring to front or send to the back a window.
hint: put the map in the back and other smaller windows in the front the select a transparency of 0.6, O.7 for the 
front windows

- perspective:
* as more and more plugins may saturate the display, capcode is organised in "perspective".
* during navigation, select the navigation perspective. Only the frames useful in navigation will be displayed.
* for polar capture or search of the best vmg, use the polar perspective.
* create your own perspective. just position the windows you need and select perspective/save as...

-Help:
  * when connected to the www, clicking on Help/index will lead you to the capcode wiki.
  * there is no other help for the moment (we are still in beta).
  
- acquisition of NMEA data
  * since 0.9.1 a configuration file (configuration/dataMap.xml) ensure the mapping between
  * NMEA fields and data used by capcode.
  * since 0.9.4 this mapping can be edited directly in capcode
  * see "how to configure capcode" in the capcode wiki
  * since 0.9.4 capcode allows to define a specific baudrate for a given port
  to define a baud rate for a com port:
  open plugins/org.capcode.acquire/plugin.xml
  find the line:
  <init method="init" param="$comport* -a 127.0.0.1 -p 7000"/>
  and set the required baud rate for a given com as follow:
  <init method="init" param="$comport* COM5/115200 -a 127.0.0.1 -p 7000"/>

- polar:
  * capcode display the polar in the "helmsman display" window. The polar is displayed depending on the true wind force.
  * the true wind angle allows the computation of the target speed and the vmg (upwind and downwind)
  * since beta version 0.9.1 the polar is also displayed on the map. The polar is displayed based on the 
  * true (geographic) wind received by the boat. You need then of course to have a good reference (true bearing instrument)
  * or a GPS connected to the PC (see configuration of capcode).
  * since 0.9.3, the polar shows "distances" that would be run during a given period of time (change this time in preferences)
  
- Maps: Capcode display 2 types of maps 
  * the "ccmap" or capcode maps are xml headers with raster home made maps.
  * the  KAP nautical charts
    - limited to BSB Version 3 (4 and 5, encrypted are not supported)
  
  * when zoom in and out the closest map to the displayed scaled is selected. 
  (this can be deactivated by selecting the yellow pin button)
 
 - Weather informations
  * capability to read and display directly on the navigation maps grib files. 
  * Download a grib file in the grib directory. Open this file in capcode.
  * the closest time of weather will be displayed but any hour/day can be called and displayed.
  * only wind at 10m and pressure on ground are displayed so far.
  * possibility to display the real time weather 
  * (ATTENTION: this can slow down dramatically the software when using big scales maps)
  * in this case, the weather is computed in real time, on any position of the map. 
  * It is possible to know the wind over the mouse position.
  * the wind at boat position is also displayed in a "weather" frame.
  * the weather can be animated to see how Lows and High are moving on your route (or vice versa).
  
- GPS
  * uncertainty of the position is computed and displayed on the map
  
- management of routes (tracks) 
  * directly on the map or by selecting a popup menu in the track window.
  * Ctrl+Click adds a waypoint
  * Shift+click removes a waypoint
  * waypoints presented in a window, next bearing and distance
  * a popup menu allow to add before or after a waypoint, edit a waypoint or to go direct to the waypoint

- wind repeater displays now also the true wind
- polars are now in ".pol" files. Can be imported from a text files (csv) see examples of csv in 
the polars directory if you want to create your own.

- AIS:
 * display the vessels around you when capcode is connected to an AIS receiver.
 * in worldwind, the ship turns red when she is on a collision route.
 
- WORLDWIND:
this fantastic java tool developed by some smart guys at NASA is now incorporated in capcode. Please have a look.
So far you can:
- insert your maps in the worldwind
- see the boat at is gps position
- select 3 different view (free, overhead, and follow) try them all,
 it will be shorter for you to try then for me to write it down here :)
- display the route: you can move the waypoints by dragging but you still cannot create points directly here. 
This will be added later.


4) CHANGE LOG
see http://sourceforge.net/apps/trac/capcode/query?status=closed&groupdesc=1&group=priority&order=priority&col=id&col=summary&milestone=version+0.9.4+beta&resolution=fixed&row=description
for a list of changes introduced by this version.
beta 0.9.4:
#6	wordwind plugin for capcode
#37	required by ticket 6: install a change waypoint event mechanism
#40	when importing a polar, ask also to save it under capcode format.
#38	store the last active waypoint in the track file
#28	progress window does  not show when user ask to build catalog
#34	manage plugins
#35	Error in chart editor
#39	update of the plugin mechanism
#41	list of minor corrections found during development
#32	add posibility to select a different language than the computer's default
#33	change the logging of event
#42	add AIS capability
#43	Improvement of the repeater displays

beta 0.9.3: 
see http://sourceforge.net/apps/trac/capcode/query?status=closed&groupdesc=1&group=priority&order=priority&col=id&col=summary&milestone=version+0.9.3+beta&resolution=fixed&row=description
for a list of changes introduced by this version.
#12  	 update the dispay algorithm for the boat trace
#13 	add a menu connecting to the grib tool
#23 	update the SDP to take into account the use of Trac
#26 	add a "build catalog" in map menu
#29 	move the display of the target VMG arrow to the polar on map plugin
#15 	federate all map directories
#16 	display the lower scaled visible maps on any map
#22 	add reference points to maps
        (Finally the solution was to implement a mapEditor)
#25 	issue with serial port under window XP
#30 	add a close button on all internal frames
#31 	add a filter in the map selection


beta 0.9.2 introduce the following changes;
- corrects a bug when using zygrib files.
- improvement in the display of some non NOAA BSB files
 
beta 0.9.1 introduce the following task resolutions:
==>task 2788912 - display the polar on the map (FR 2787892 )
https://sourceforge.net/tracker/?func=detail&aid=2788912&group_id=100698&atid=1045270
==>task "externalise strings": 
modified capcode for multi-language capabilities.
==>task 2599244 - error in orthodromy computation
https://sourceforge.net/tracker/?func=detail&atid=628070&aid=2599244&group_id=100698
==>task "display the equipments connected to PC"
upgrade of this function (allow to see which equipments are connected to which serial port)  
==>task "zygrib"
grib files from zygrib were not properly displayed in capcode. Not any more.
==> task "new repeater (multi)"
unfinished new repeater.
==>task 2705654 - NMEA data mapping (FR 2605966 Input Mapping)
https://sourceforge.net/tracker2/index.php?func=detail&aid=2705654&group_id=100698&atid=1045270
-------------------------------------------------------------------------------------- 
beta 0.9 introduced the following task resolutions:
==> task 2533241 GPS speed spare mode
https://sourceforge.net/tracker2/?func=detail&aid=2533241&group_id=100698&atid=1045270
==> correction of a bug on preferences for windows 
==> task 2595996 - helmsman display should not access directly the speed polar
https://sourceforge.net/tracker2/?func=detail&aid=2595996&group_id=100698&atid=1045270
==> task 2531747 animation of the weather
https://sourceforge.net/tracker2/?func=detail&aid=2024403&group_id=100698&atid=1045270
==> task 2531530 - save toolbars status and position when floating
https://sourceforge.net/tracker2/?func=detail&aid=2531530&group_id=100698&atid=1045270
==> task 2159980 get the weather information for a time and location
==> task 2577644 - SpeedPolar implement polar in tables
https://sourceforge.net/tracker2/?func=detail&aid=2577644&group_id=100698&atid=1045270
==> task 2577326 - helmsman display: auto scale
https://sourceforge.net/tracker2/?func=detail&aid=2577326&group_id=100698&atid=1045270
==> Map zoom: take the zoom factor into account when draggin the map
==> task 2599244 - error in orthodromy computation
https://sourceforge.net/tracker/?func=detail&atid=628070&aid=2599244&group_id=100698
==> task  2595952 - FR 2537699 - waypoint files
https://sourceforge.net/tracker2/?func=detail&aid=2595952&group_id=100698&atid=1045270
==> task 2024395 - FR 1951428 complement the NMEA messages
https://sourceforge.net/tracker2/?func=detail&aid=2024395&group_id=100698&atid=1045270
==> implement the possibility to change perspective  
==> 2611676 - take also MWV into account for computation of trueWind
https://sourceforge.net/tracker2/?func=detail&aid=2611676&group_id=100698&atid=1045270
==> display the equipments connected to PC 
-------------------------------------------------------------------------------------- 
 from beta 0.8.1 to 0.8.2 correction of bug 2470945 (track not saved in version 0.8.1)
 we took also the opportunity of the correction of this bug to introduce in the waypoint window the 
 cumulated distance to destination.