Skip to content

GitLab

Closed
Created by snuverink_j@snuverink_jDeveloper15 of 15 tasks completed15/15 tasks

File header for OPAL source proposal

The following discussion from !294 (merged) should be addressed:

  • @gsell started a discussion: (+4 comments)

    @snuverink_j @ext-rogers_c Ok, maybe we have to change/extend the file header for OPAL source files according the recommendations in https://www.gnu.org/licenses/gpl-howto.html. What do you think about the following proposal:

    //
// Brief description
//
// Copyright (c) YYYY, Notice mentioning University, Institute, Lab or Author
//
// Optional: related work, e.g. title of PhD or Master thesis
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL.  If not, see <https://www.gnu.org/licenses/>.
//

    For PSI employees the copyright notice would be:

    // Copyright (c) YYYY1[, YYYY2...], Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved.

    For a PhD or Master student something like:

    // Copyright (c) YYYY1[, YYYY2...], Firstname Lastname, University
// All rights reserved

    My proposal for the header of the file MapAnalyser.h would be something like:

    //
// Class: MapAnalyser
//   Organizes the function for a linear map analysis from
//   ThickTracker.
//   Transfer map -> tunes, symplecticity and stability
//   Sigma Matrix -> (not projected) beam emittance
//
// This class is in an unfinished state.
// For some dicussion see https://gitlab.psi.ch/OPAL/src/issues/464
// Some cleanup was done in https://gitlab.psi.ch/OPAL/src/merge_requests/294
//
// Copyright (c) 2017, Philippe Ganz, ETH Zürich
// All rights reserved
//
// Implemented as part of the Master thesis
// "s-based maps from TPS & Lie-Series applied to Proton-Therapy Gantries"
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL.  If not, see <https://www.gnu.org/licenses/>.
//

Tasks:

Edited by frey_m