New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
Developers – NEMO
wiki:Developers

Version 61 (modified by clevy, 5 years ago) (diff)

--

Welcome to the NEMO developers section









Color(IMPORTANT to be able to create a ticket or add a topic in a forum, if you don't already have a user account then you have to '''[/register create it by clicking here]''',/lime)?

Overview of NEMO development process

NEMO is a free licence software, so anyone can use and develop NEMO for its own purposes.
The NEMO reference code is available through official releases following some precise developement plan and quality control processes.The NEMO reference is under the responsibility of the NEMO System Team.

All suggestions or developments from the community are welcome and can be announced in one of the forums.

A development can be eligible for the NEMO reference. If so, this task should be added to NEMO development annual work plan.
As a first step,a ticket should be opened to describe the development and its implementation, so as the existing validations.
This ticket will be examined by NEMO Developer's Committee to decide if the development is relevant and useful for the NEMO shared reference.
Once the approval of Developer's Committee is sent, the development action can be added into the NEMO development yearly work plan and will need a contribution from the intial developer to be completed.

The different options to inform, share and eventually implement your developments in the NEMO reference are described below:

A piece of software that you want to share:

  • You have a new development of NEMO, and believe it is of interest for the community, but you're not ready to do more. You are welcome to create a ticket here and attach the routines you have developped to your new ticket.

A contribution the the NEMO reference

You developed a new piece in NEMO, for your own purpose and you think it would be useful for you and/or the community to add it into the NEMO reference.
This very good idea needs a little more work, from you and also from the NEMO System Team in charge of NEMO development.

As a first step, you should, as above, open a ticket here:
describing the development. Please create it with a "TASK" type, so that the NEMO Developer's Committee can take it in account.

Listing a development action in the NEMO reference development plan is decision with strong implications: first criteria is of course the scientific interest, but the amount of work needed to successfully meet the quality control requirements has also to be evaluated. This concerns:

  • The overall coherency with NEMO development strategy
  • Coding rules, performances
  • Documentation (in the code, on-line and reference manual)
  • Building the development branch in phase with latest NEMO release
  • Validation phase: checking that the development does what is expected, and that it is not breaking any existing feature (in terms of natural, computer sciences and of performances)

The NEMO System Team will ask you to contribute to the implementation work in the NEMO reference: you will be the PI of this action with the perspective of merging this new development by the end of civil year, during the so-called "Merge Party" meeting. If you agree with this perspective, you will be contacted by a member of NEMO System Team who will help you through the different development steps.

Development activities

Document your developments before coding by following the procedure described at Developers/DevelopingCodeChanges

Support

Forums

Discussion

  • If you want to follow a particular resource, set your email in your preferences and follow the instructions:
    • Wiki: click on 'Watch page' in the contextual menu.
    • Forum: subscribe to a topic from the topic list or a subject from the messages list.
    • Ticket: add your ID in the 'Cc' field.
  • (|mail|) forge@nemo-ocean.eu: to be notified of each event on this platform (repository commits, ticket creation/update and forums messages).
    Very high traffic recommended for all developers