1+
2+
3+ <!DOCTYPE html>
4+ < html class ="writer-html5 " lang ="en " data-content_root ="../../ ">
5+ < head >
6+ < meta charset ="utf-8 " />
7+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
8+ < title > turn_by_turn.constants — turn_by_turn 1.0.0 documentation</ title >
9+ < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=03e43079 " />
10+ < link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=e59714d7 " />
11+ < link rel ="stylesheet " type ="text/css " href ="../../_static/css/custom.css?v=988d0652 " />
12+
13+
14+ < script src ="../../_static/jquery.js?v=5d32c60e "> </ script >
15+ < script src ="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
16+ < script src ="../../_static/documentation_options.js?v=8d563738 "> </ script >
17+ < script src ="../../_static/doctools.js?v=9bcbadda "> </ script >
18+ < script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
19+ < script src ="../../_static/js/theme.js "> </ script >
20+ < link rel ="index " title ="Index " href ="../../genindex.html " />
21+ < link rel ="search " title ="Search " href ="../../search.html " />
22+ </ head >
23+
24+ < body class ="wy-body-for-nav ">
25+ < div class ="wy-grid-for-nav ">
26+ < nav data-toggle ="wy-nav-shift " class ="wy-nav-side ">
27+ < div class ="wy-side-scroll ">
28+ < div class ="wy-side-nav-search " >
29+
30+
31+
32+ < a href ="../../index.html ">
33+
34+ < img src ="../../_static/omc_logo.svg " class ="logo " alt ="Logo "/>
35+ </ a >
36+ < div role ="search ">
37+ < form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
38+ < input type ="text " name ="q " placeholder ="Search docs " aria-label ="Search docs " />
39+ < input type ="hidden " name ="check_keywords " value ="yes " />
40+ < input type ="hidden " name ="area " value ="default " />
41+ </ form >
42+ </ div >
43+ </ div > < div class ="wy-menu wy-menu-vertical " data-spy ="affix " role ="navigation " aria-label ="Navigation menu ">
44+ < p class ="caption " role ="heading "> < span class ="caption-text "> Modules</ span > </ p >
45+ < ul >
46+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../modules/index.html "> Constants</ a > </ li >
47+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../modules/index.html#io "> IO</ a > < ul >
48+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../../modules/index.html#reading-data "> Reading Data</ a > </ li >
49+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../../modules/index.html#writing-data "> Writing Data</ a > </ li >
50+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../../modules/index.html#supported-modules-and-limitations "> Supported Modules and Limitations</ a > </ li >
51+ < li class ="toctree-l2 "> < a class ="reference internal " href ="../../modules/index.html#api "> API</ a > </ li >
52+ </ ul >
53+ </ li >
54+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../modules/index.html#structures "> Structures</ a > </ li >
55+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../modules/index.html#utils "> Utils</ a > </ li >
56+ </ ul >
57+ < p class ="caption " role ="heading "> < span class ="caption-text "> Readers</ span > </ p >
58+ < ul >
59+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html "> DOROS</ a > </ li >
60+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#esrf "> ESRF</ a > </ li >
61+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#iota "> Iota</ a > </ li >
62+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#lhc "> LHC</ a > </ li >
63+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#sps "> SPS</ a > </ li >
64+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#ptc "> PTC</ a > </ li >
65+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#trackone "> Trackone</ a > </ li >
66+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#mad-ng "> MAD-NG</ a > </ li >
67+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../readers/index.html#xtrack-line "> XTRACK_LINE</ a > </ li >
68+ </ ul >
69+
70+ </ div >
71+ </ div >
72+ </ nav >
73+
74+ < section data-toggle ="wy-nav-shift " class ="wy-nav-content-wrap "> < nav class ="wy-nav-top " aria-label ="Mobile navigation menu " >
75+ < i data-toggle ="wy-nav-top " class ="fa fa-bars "> </ i >
76+ < a href ="../../index.html "> turn_by_turn</ a >
77+ </ nav >
78+
79+ < div class ="wy-nav-content ">
80+ < div class ="rst-content ">
81+ < div role ="navigation " aria-label ="Page navigation ">
82+ < ul class ="wy-breadcrumbs ">
83+ < li > < a href ="../../index.html " class ="icon icon-home " aria-label ="Home "> </ a > </ li >
84+ < li class ="breadcrumb-item "> < a href ="../index.html "> Module code</ a > </ li >
85+ < li class ="breadcrumb-item active "> turn_by_turn.constants</ li >
86+ < li class ="wy-breadcrumbs-aside ">
87+ </ li >
88+ </ ul >
89+ < hr />
90+ </ div >
91+ < div role ="main " class ="document " itemscope ="itemscope " itemtype ="http://schema.org/Article ">
92+ < div itemprop ="articleBody ">
93+
94+ < h1 > Source code for turn_by_turn.constants</ h1 > < div class ="highlight "> < pre >
95+ < span > </ span > < span class ="sd "> """</ span >
96+ < span class ="sd "> Constants</ span >
97+ < span class ="sd "> ---------</ span >
98+
99+ < span class ="sd "> Specific constants to be used in ``turn_by_turn``, to help with consistency.</ span >
100+ < span class ="sd "> """</ span >
101+
102+ < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> __future__</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> annotations</ span >
103+
104+ < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> typing</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> TYPE_CHECKING</ span > < span class ="p "> ,</ span > < span class ="n "> TypedDict</ span >
105+
106+ < span class ="k "> if</ span > < span class ="n "> TYPE_CHECKING</ span > < span class ="p "> :</ span >
107+ < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> datetime</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> datetime</ span >
108+ < span class ="kn "> from</ span > < span class ="w "> </ span > < span class ="nn "> pathlib</ span > < span class ="w "> </ span > < span class ="kn "> import</ span > < span class ="n "> Path</ span >
109+
110+ < span class ="n "> PLANES</ span > < span class ="p "> :</ span > < span class ="nb "> tuple</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="nb "> str</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="p "> (</ span > < span class ="s2 "> "X"</ span > < span class ="p "> ,</ span > < span class ="s2 "> "Y"</ span > < span class ="p "> )</ span >
111+ < span class ="n "> NUM_TO_PLANE</ span > < span class ="p "> :</ span > < span class ="nb "> dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="nb "> str</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="p "> {</ span > < span class ="s2 "> "0"</ span > < span class ="p "> :</ span > < span class ="s2 "> "X"</ span > < span class ="p "> ,</ span > < span class ="s2 "> "1"</ span > < span class ="p "> :</ span > < span class ="s2 "> "Y"</ span > < span class ="p "> }</ span >
112+ < span class ="n "> PLANE_TO_NUM</ span > < span class ="p "> :</ span > < span class ="nb "> dict</ span > < span class ="p "> [</ span > < span class ="nb "> str</ span > < span class ="p "> ,</ span > < span class ="nb "> int</ span > < span class ="p "> ]</ span > < span class ="o "> =</ span > < span class ="p "> {</ span > < span class ="s2 "> "X"</ span > < span class ="p "> :</ span > < span class ="mi "> 0</ span > < span class ="p "> ,</ span > < span class ="s2 "> "Y"</ span > < span class ="p "> :</ span > < span class ="mi "> 1</ span > < span class ="p "> }</ span >
113+
114+ < span class ="c1 "> # ----- Common Meta Keys ----- #</ span >
115+
116+ < div class ="viewcode-block " id ="MetaDict ">
117+ < a class ="viewcode-back " href ="../../modules/index.html#turn_by_turn.constants.MetaDict "> [docs]</ a >
118+ < span class ="k "> class</ span > < span class ="w "> </ span > < span class ="nc "> MetaDict</ span > < span class ="p "> (</ span > < span class ="n "> TypedDict</ span > < span class ="p "> ,</ span > < span class ="n "> total</ span > < span class ="o "> =</ span > < span class ="kc "> False</ span > < span class ="p "> ):</ span >
119+ < span class ="w "> </ span > < span class ="sd "> """ Metadata dictionary, to type-hint known entries.</ span >
120+ < span class ="sd "> None of the entries are required (``total=False``).</ span >
121+
122+ < span class ="sd "> Attributes:</ span >
123+ < span class ="sd "> date (datetime): Date of the measurement/creation of the data</ span >
124+ < span class ="sd "> file (Path | str): Path to the file the data was loaded from (if available).</ span >
125+ < span class ="sd "> machine (str): Name of the machine the data was measured/simulated on.</ span >
126+ < span class ="sd "> source_datatype (str): The datatype this data was loaded from.</ span >
127+ < span class ="sd "> comment (str): Any comment on the measurement.</ span >
128+ < span class ="sd "> """</ span >
129+ < span class ="n "> date</ span > < span class ="p "> :</ span > < span class ="n "> datetime</ span >
130+ < span class ="n "> file</ span > < span class ="p "> :</ span > < span class ="n "> Path</ span > < span class ="o "> |</ span > < span class ="nb "> str</ span >
131+ < span class ="n "> machine</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span >
132+ < span class ="n "> source_datatype</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span >
133+ < span class ="n "> comment</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > </ div >
134+
135+
136+ < span class ="c1 "> # ----- Miscellaneous ----- #</ span >
137+
138+ < span class ="n "> PRINT_PRECISION</ span > < span class ="p "> :</ span > < span class ="nb "> int</ span > < span class ="o "> =</ span > < span class ="mi "> 6</ span >
139+ < span class ="n "> FORMAT_STRING</ span > < span class ="p "> :</ span > < span class ="nb "> str</ span > < span class ="o "> =</ span > < span class ="sa "> f</ span > < span class ="s2 "> " </ span > < span class ="se "> {{</ span > < span class ="s2 "> :.</ span > < span class ="si "> {</ span > < span class ="n "> PRINT_PRECISION</ span > < span class ="si "> :</ span > < span class ="s2 "> d</ span > < span class ="si "> }</ span > < span class ="s2 "> f</ span > < span class ="se "> }}</ span > < span class ="s2 "> "</ span >
140+ </ pre > </ div >
141+
142+ </ div >
143+ </ div >
144+ < footer >
145+
146+ < hr />
147+
148+ < div role ="contentinfo ">
149+ < p > © Copyright .</ p >
150+ </ div >
151+
152+ Built with < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > using a
153+ < a href ="https://github.com/readthedocs/sphinx_rtd_theme "> theme</ a >
154+ provided by < a href ="https://readthedocs.org "> Read the Docs</ a > .
155+
156+
157+ </ footer >
158+ </ div >
159+ </ div >
160+ </ section >
161+ </ div >
162+ < script >
163+ jQuery ( function ( ) {
164+ SphinxRtdTheme . Navigation . enable ( true ) ;
165+ } ) ;
166+ </ script >
167+
168+ </ body >
169+ </ html >
0 commit comments