Contribution Guide

🔴 This is a draft of contribution guide all suggestions/corrections are welcome.

Introduction

Py-ORBIT is an open source code for simulating particle accelerators. More information can be found at [Py-ORBIT website}(https://pyorbit-collaboration.github.io/). The code is organized in several repositories to allow flexibility of development for different institutions. All repositories are placed in one GitHub organization - PyORBIT-Collaboration.

Project structure

The main parts of Py-ORBIT are:

1. Core contains C++ and Python code that provides core functionality. This part is required for running Py-ORBIT code.
2. Extensions provide additional functionality that is not required to run simulations. Usually extensions deal with less typical physics processes (e.g. laser stripping) or interface Py-ORBIT to other accelerator codes (e.g. PTC).

Core repository

Extensions

PS q q q q q q

Site specific code