From 35fd7d40445cc846ba5ef5fdd209e09146b18859 Mon Sep 17 00:00:00 2001
From: Yngve Inntjore Levinsen <Yngve.Levinsen@esss.se>
Date: Fri, 11 Mar 2016 11:55:59 +0100
Subject: [PATCH] added parameter documentation for LATTICE.__init__
---
ess/lib_tw.py | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/ess/lib_tw.py b/ess/lib_tw.py
index 702a95b..30684a9 100644
--- a/ess/lib_tw.py
+++ b/ess/lib_tw.py
@@ -34,6 +34,12 @@ class LATTICE:
2015.10.14
'''
def __init__(self,file_name_lat,file_name_fmap=[],freq=352.21,gamma=1.0):
+ '''
+ :param file_name_lat: name of lattice file
+ :param file_name_fmap: list of file map files
+ :param freq: RF frequency
+ :param gamma: relativistic gamma
+ '''
# In case file_name_fmap is str
if isinstance(file_name_fmap,basestring): file_name_fmap=[file_name_fmap]
--
GitLab