Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
S src
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 62
    • Issues 62
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge requests 4
    • Merge requests 4
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Analytics
    • Analytics
    • CI/CD
    • Code Review
    • Issue
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OPAL
  • src
  • Issues
  • #482

Closed
Open
Created Mar 11, 2020 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:

  • Extend the list of student files (@frey_m)
  • Adapt source files from students
    • Strongly modified classes (e.g. PartBunchBase and RK4) (as pointed out in #501 (closed)) (fixed with !380 (merged))
    • OPAL-map and Matched distribution (!308 (merged))
      • Fix .cpp files with same file header as header files (!355 (merged))
    • Beam stripping physics (see !328 (merged))
    • Optimiser (see !323 (merged)),
    • SAAMG solver (see !324 (merged))
      • Fix: SAAMG originally developed in MSc thesis not PhD (see comment !327 (comment 20157)) (!369 (merged))
    • envelope tracker (Yves Ineichen ?) Edit: This solver got removed (see !343 (merged)).
    • @frey_m see #501 (closed)
    • all DKS stuff is @locans_u's work Edit: DKS got removed (see #523 (closed))
    • all P3M files are part of Benjamin Ulmer's work (see !325 (merged))
    • Cyclotron work by Jianjun Yang (!356 (merged))
  • Update wiki on code style
Edited Jun 08, 2020 by frey_m
Assignee
Assign to
OPAL 2.4.0
Milestone
OPAL 2.4.0 (Past due)
Assign milestone
Time tracking