1+
2+
3+ <!DOCTYPE html>
4+ < html class ="writer-html5 " lang ="en " data-content_root ="../../ ">
5+ < head >
6+ < meta charset ="utf-8 " /> < meta name ="viewport " content ="width=device-width, initial-scale=1 " />
7+
8+ < meta name ="viewport " content ="width=device-width, initial-scale=1.0 " />
9+ < title > Code documentation — Xmipp 1.0.0 documentation</ title >
10+ < link rel ="stylesheet " type ="text/css " href ="../../_static/pygments.css?v=b86133f3 " />
11+ < link rel ="stylesheet " type ="text/css " href ="../../_static/css/theme.css?v=e59714d7 " />
12+ < link rel ="stylesheet " type ="text/css " href ="../../_static/custom.css " />
13+
14+
15+ < link rel ="shortcut icon " href ="../../_static/favicon.ico "/>
16+ < script src ="../../_static/jquery.js?v=5d32c60e "> </ script >
17+ < script src ="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c "> </ script >
18+ < script src ="../../_static/documentation_options.js?v=8d563738 "> </ script >
19+ < script src ="../../_static/doctools.js?v=9a2dae69 "> </ script >
20+ < script src ="../../_static/sphinx_highlight.js?v=dc90522c "> </ script >
21+ < script src ="../../_static/js/theme.js "> </ script >
22+ < link rel ="index " title ="Index " href ="../../genindex.html " />
23+ < link rel ="search " title ="Search " href ="../../search.html " />
24+ < link rel ="next " title ="Useful Tricks and Scripts " href ="../UsefulScripts/index.html " />
25+ < link rel ="prev " title ="Tips " href ="../Tips/index.html " />
26+ </ head >
27+
28+ < body class ="wy-body-for-nav ">
29+ < div class ="wy-grid-for-nav ">
30+ < nav data-toggle ="wy-nav-shift " class ="wy-nav-side ">
31+ < div class ="wy-side-scroll ">
32+ < div class ="wy-side-nav-search " >
33+
34+
35+
36+ < a href ="../../index.html " class ="icon icon-home ">
37+ Xmipp
38+ </ a >
39+ < div role ="search ">
40+ < form id ="rtd-search-form " class ="wy-form " action ="../../search.html " method ="get ">
41+ < input type ="text " name ="q " placeholder ="Search docs " aria-label ="Search docs " />
42+ < input type ="hidden " name ="check_keywords " value ="yes " />
43+ < input type ="hidden " name ="area " value ="default " />
44+ </ form >
45+ </ div >
46+ </ div > < div class ="wy-menu wy-menu-vertical " data-spy ="affix " role ="navigation " aria-label ="Navigation menu ">
47+ < p class ="caption " role ="heading "> < span class ="caption-text "> Installing Xmipp</ span > </ p >
48+ < ul >
49+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Installation/Requirements/index.html "> Requirements</ a > </ li >
50+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Installation/Installations/index.html "> Installations</ a > </ li >
51+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Installation/Optionals/index.html "> Optional Tools and Libraries</ a > </ li >
52+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Installation/Troubleshooting/index.html "> Troubleshooting</ a > </ li >
53+ </ ul >
54+ < p class ="caption " role ="heading "> < span class ="caption-text "> Releases</ span > </ p >
55+ < ul >
56+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Releases/Releases-xmipp-program/index.html "> Releases xmipp program</ a > </ li >
57+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Releases/Releases-scipion-em-xmipp/index.html "> Releases scipion-em-xmipp</ a > </ li >
58+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Releases/Releases-scipion-em-xmippTomo/index.html "> Releases scipion-em-xmippTomo</ a > </ li >
59+ </ ul >
60+ < p class ="caption " role ="heading "> < span class ="caption-text "> Xmipp World</ span > </ p >
61+ < ul >
62+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../protocolsMap.html "> Protocols Map</ a > </ li >
63+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../thePowerOfXmipp.html "> The power of Xmipp</ a > </ li >
64+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../listOfPublications.html "> List of Publications</ a > </ li >
65+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../history.html "> Timeline of Xmipp</ a > </ li >
66+ </ ul >
67+ < p class ="caption " role ="heading "> < span class ="caption-text "> Utils</ span > </ p >
68+ < ul >
69+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Utils/ConfigurationF/index.html "> Configuration File</ a > </ li >
70+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Utils/xmippStructure/index.html "> Xmipp structure</ a > </ li >
71+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Utils/Conventions/index.html "> Conventions</ a > </ li >
72+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Utils/Deprecated-programs/index.html "> Programs deprecated</ a > </ li >
73+ </ ul >
74+ < p class ="caption " role ="heading "> < span class ="caption-text "> Developers</ span > </ p >
75+ < ul class ="current ">
76+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../Welcome-developers/index.html "> Welcome Developers! 👋</ a > </ li >
77+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../Guidelines/index.html "> Guidelines</ a > </ li >
78+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../Tips/index.html "> Tips</ a > </ li >
79+ < li class ="toctree-l1 current "> < a class ="current reference internal " href ="# "> Code documentation</ a > </ li >
80+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../UsefulScripts/index.html "> Useful Tricks and Scripts</ a > </ li >
81+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../How-to-release/index.html "> Creating an Xmipp Release</ a > </ li >
82+ </ ul >
83+ < p class ="caption " role ="heading "> < span class ="caption-text "> Others</ span > </ p >
84+ < ul >
85+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Others/Enhancing/index.html "> Data Collection</ a > </ li >
86+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Others/Contact/index.html "> Contact us</ a > </ li >
87+ < li class ="toctree-l1 "> < a class ="reference internal " href ="../../Others/License/index.html "> License</ a > </ li >
88+ </ ul >
89+
90+ </ div >
91+ </ div >
92+ </ nav >
93+
94+ < section data-toggle ="wy-nav-shift " class ="wy-nav-content-wrap "> < nav class ="wy-nav-top " aria-label ="Mobile navigation menu " >
95+ < i data-toggle ="wy-nav-top " class ="fa fa-bars "> </ i >
96+ < a href ="../../index.html "> Xmipp</ a >
97+ </ nav >
98+
99+ < div class ="wy-nav-content ">
100+ < div class ="rst-content style-external-links ">
101+ < div role ="navigation " aria-label ="Page navigation ">
102+ < ul class ="wy-breadcrumbs ">
103+ < li > < a href ="../../index.html " class ="icon icon-home " aria-label ="Home "> </ a > </ li >
104+ < li class ="breadcrumb-item active "> Code documentation</ li >
105+ < li class ="wy-breadcrumbs-aside ">
106+ < a href ="../../_sources/Developers/CodeDocumentation/index.rst.txt " rel ="nofollow "> View page source</ a >
107+ </ li >
108+ </ ul >
109+ < hr />
110+ </ div >
111+ < div role ="main " class ="document " itemscope ="itemscope " itemtype ="http://schema.org/Article ">
112+ < div itemprop ="articleBody ">
113+
114+ < section id ="code-documentation ">
115+ < h1 > Code documentation< a class ="headerlink " href ="#code-documentation " title ="Link to this heading "> </ a > </ h1 >
116+ < p > This documentation serves as a valuable resource for developers, offering detailed information about the source code, such as function/method descriptions, class details, variable explanations, data structures, inter-component relationships, and more.</ p >
117+ < ul class ="simple ">
118+ < li > < p > < a class ="reference external " href ="https://i2pc.github.io/xmippDoc/html/modules.html "> Xmipp C++ code</ a > </ p > </ li >
119+ < li > < p > < a class ="reference external " href ="https://i2pc.github.io/xmippPythonDoc/html/index.html "> Xmipp Python code</ a > </ p > </ li >
120+ < li > < p > < a class ="reference external " href ="https://i2pc.github.io/xmippJavaDoc/html/index.html "> Xmipp Java code</ a > </ p > </ li >
121+ </ ul >
122+ </ section >
123+
124+
125+ </ div >
126+ </ div >
127+ < footer > < div class ="rst-footer-buttons " role ="navigation " aria-label ="Footer ">
128+ < a href ="../Tips/index.html " class ="btn btn-neutral float-left " title ="Tips " accesskey ="p " rel ="prev "> < span class ="fa fa-arrow-circle-left " aria-hidden ="true "> </ span > Previous</ a >
129+ < a href ="../UsefulScripts/index.html " class ="btn btn-neutral float-right " title ="Useful Tricks and Scripts " accesskey ="n " rel ="next "> Next < span class ="fa fa-arrow-circle-right " aria-hidden ="true "> </ span > </ a >
130+ </ div >
131+
132+ < hr />
133+
134+ < div role ="contentinfo ">
135+ < p > © Copyright 2025, Xmipp team.</ p >
136+ </ div >
137+
138+ Built with < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > using a
139+ < a href ="https://github.com/readthedocs/sphinx_rtd_theme "> theme</ a >
140+ provided by < a href ="https://readthedocs.org "> Read the Docs</ a > .
141+
142+
143+ </ footer >
144+ </ div >
145+ </ div >
146+ </ section >
147+ </ div >
148+ < script >
149+ jQuery ( function ( ) {
150+ SphinxRtdTheme . Navigation . enable ( true ) ;
151+ } ) ;
152+ </ script >
153+
154+ </ body >
155+ </ html >
0 commit comments