.. image:: https://travis-ci.org/blond-org/blond_common.svg?branch=master :target: https://travis-ci.org/blond-org/blond_common .. image:: https://ci.appveyor.com/api/projects/status/065ucd9c93vm7089/branch/master?svg=true :target: https://ci.appveyor.com/project/blond-admin/blond-common .. image:: https://coveralls.io/repos/github/blond-org/blond_common/badge.svg?branch=master :target: https://coveralls.io/github/blond-org/blond_common?branch=master

Copyright 2019 CERN. This software is distributed under the terms of the GNU General Public Licence version 3 (GPL Version 3), copied verbatim in the file LICENCE.txt. In applying this licence, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.

CODE NAME

BLonD_common (Beam Longitudinal Dynamics - Common dependencies)

DESCRIPTION

Collection of common functions and interfaces for codes dedicated to longitudinal beam dynamics studies in synchrotrons

LINKS

Repository: https://github.com/blond-org/blond_common

Documentation: http://blond-org.github.io/blond_common/

Project website: http://blond.web.cern.ch

INSTALL

Requirements

1. An Anaconda distribution (Python 3 recommended).

2. That's all!

Install Steps

• The blond_common module is initially meant to be used as a submodule to other code developments. If you would like to add the blond_common module into your own development, you need to: .. code-block:: bash

  $ git submodule add https://github.com/blond-org/blond_common.git your_project

• If the blond_common module is included as a submodule into another project, remember to initialize the module using (NB: this will update the submodule to the version defined by the project): .. code-block:: bash

  $ git submodule init
  $ git submodule update

• The code can also be used standalone (e.g. to use fitting functions)

  1. Clone the repository from github or download and extract the zip from here_.

  2. Add the folder ON TOP of the blond_common module to your PYTHONPATH (e.g. if the folders are structured as /foo/bar/blond_common, you should add the "bar" folder to the PYTHONPATH, see in __EXAMPLES)

CURRENT DEVELOPERS

• Simon Albright (simon.albright (at) cern.ch)
• Theodoros Argyropoulos (theodoros.argyropoulos (at) cern.ch)
• Konstantinos Iliakis (konstantinos.iliakis (at) cern.ch)
• Ivan Karpov (ivan.karpov (at) cern.ch)
• Alexandre Lasheen (alexandre.lasheen (at) cern.ch)
• Helga Timko (Helga.Timko (at) cern.ch)

PREVIOUS DEVELOPERS

• Juan Esteban Muller
• Danilo Quartullo
• Joel Repond

STRUCTURE

To be described

VERSION CONTENTS

No stable version at the moment