From Helioviewer Wiki

(Redirected from Development)

This page contains information relating to the development of the Helioviewer Project.

Introduction

Development for Helioviewer is divided up by project, the major ones being:

Helioviewer.org - Web front-end
JHelioviewer - Java front-end
The Helioviewer JPIP Server - JPEG 2000 streaming server
JP2Gen - Conversion of FITS files to JPEG 2000.

Revision control and bug & feature tracking are managed through Launchpad. There is also a developer mailing list hosted at Google Groups which is open for anyone to join. Interested individuals are encouraged to sign up for an account on Launchpad and grab the latest version of whichever project they are interested in. Once you have a good understanding of the software, and are ready to contribute, create a development branch (e.g. lp:~john/helioviewer.org/john-dev) the code section for your project at Launchpad and add your changes.

Helioviewer Development Guidelines

Coding Standards:
- Java: We have adopted Sun's official Java Code Conventions. An Eclipse settings file for our coding standards can be found on Formatting.
- JS: Douglas Crockford's Code Conventions for the JavaScript Programming Language is used as a guideline. JSLint is also recommended to maintain good code.
- PHP: We have adopted the PEAR PHP coding standards. (line-width: 120)
Documentation
- Java: Javadoc
- JS: JsDoc Toolkit
- PHP: phpDocumentor
JHelioviewer Development Introduction
JHelioviewer Code Documentation

Resources

Helioviewer

The principle packages used are:

JavaScript
jQuery

Bazaar

We use the distributed version control system Bazaar, in connection with the code hosting and software collaboration platform Launchpad.

"Bazaar in five minutes"
The Bazaar User Guide is a very helpful resource to get started. It is recommended to read the first six chapters, including "Team collaboration, distributed style".

Programming

Bruce Eckel's Thinking in Java (3rd ed., free e-book)

JPEG2000

JPEG2000 file design for the Helioviewer Project - Explains some of the details and motivation regarding the specific parameters chosen for use in Helioviewer.
Helioviewer JP2 XML Tags - List of XML tags in Helioviewer-formatted JP2 images.
FITS2HV - Describes how the FITS keywords are used in the Helioviewer project.
Some articles on JPEG 2000

Future Development

There are three places where ideas for future features can be created and stored:

Helioviewer Brainstorm - A place to list any ideas for the project for future reference. Eventually ideas which are decided to be worth acting on can then be transfered to either a Launchpad feature-request or blue-print.
Launchpad Bugs/Wishlist - In Launchpad's bug-tracking system, feature-requests can be marked as having the priority "wishlist".
Launchpad Development Blueprints - Larger-scale projects can be described and assigned using Launchpad's "Blueprint" feature.