-
Notifications
You must be signed in to change notification settings - Fork 4
/
index_doc.html
437 lines (417 loc) · 36.7 KB
/
index_doc.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to LITESOPH’s Documentation! — LITESOPH 0.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=2709fde1"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>window.MathJax = {"tex": {"macros": {"br": "{\\mathbf r}", "bk": "{\\mathbf k}", "bG": "{\\mathbf G}"}}}</script>
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="About LITESOPH" href="about_LITESOPH.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
LITESOPH
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="about_LITESOPH.html">About LITESOPH</a></li>
<li class="toctree-l1"><a class="reference internal" href="about_LITESOPH.html#engines-interfaced-with-litesoph">Engines Interfaced with LITESOPH</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#getting-the-source-code-of-litesoph">Getting the source code of LITESOPH</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#configuration">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#example-lsconfig-file">Example lsconfig file</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#usage">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="feature_and_implementations/features_and_implementation.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_documentation/user_documentation_index.html">User Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples/examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="devel/devel.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="FAQs/FAQ.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bugs.html">Bugs!</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="people.html">Team Litesoph</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">LITESOPH</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to LITESOPH’s Documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-litesoph-s-documentation">
<h1>Welcome to LITESOPH’s Documentation!<a class="headerlink" href="#welcome-to-litesoph-s-documentation" title="Link to this heading"></a></h1>
<p>The LITESOPH project is aimed at developing a comprehensive toolkit to launch, monitor, manage and analyze large-scale simulations
of photo-induced phenomena in a high-performance computing (HPC) environment. It is designed to serve the needs of computational
researchers interested in solar energy conversion applications (photovoltaics, water-splitting catalysts, solar fuels, etc.),
optoelectronic materials, photochemistry and photobiology. The toolkit consists of several Python-based layers driven by
popular and open-source TDDFT codes like OCTOPUS, GPAW and NWChem.</p>
<p><strong>LITESOPH</strong> is the abbreviated form of <em>Layer Integrated Toolkit and Engine for Simulations Of
Photo-Induced Phenomena</em>.
It is a GUI-based software to perform the ground state DFT and TDDFT calculations
using three engines: <a class="reference external" href="https://wiki.fysik.dtu.dk/gpaw/index.html">GPAW</a>, <a class="reference external" href="https://nwchemgit.github.io/">NWChem</a> and
<a class="reference external" href="https://octopus-code.org/wiki/Main_Page">Octopus</a>.</p>
<section id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="about_LITESOPH.html">About LITESOPH</a></li>
<li class="toctree-l1"><a class="reference internal" href="about_LITESOPH.html#engines-interfaced-with-litesoph">Engines Interfaced with LITESOPH</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="installation.html#id1"><strong>Python</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="installation.html#engines"><strong>Engines</strong></a><ul>
<li class="toctree-l3"><a class="reference internal" href="installation.html#gpaw"><strong>GPAW</strong></a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#nwchem"><strong>NWchem</strong></a></li>
<li class="toctree-l3"><a class="reference internal" href="installation.html#octopus"><strong>Octopus</strong></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#getting-the-source-code-of-litesoph">Getting the source code of LITESOPH</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#configuration">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#example-lsconfig-file">Example lsconfig file</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html#usage">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="feature_and_implementations/features_and_implementation.html">Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="feature_and_implementations/algorithm/algorithm.html">Available Features in LITESOPH</a><ul>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html">Simulations of Photo-Induced Properties using LITESOPH</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html#absorption-spectrum">Absorption Spectrum</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html#kohn-sham-decomposition-ksd">Kohn-Sham Decomposition (KSD)</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html#molecular-orbital-mo-population">Molecular Orbital (MO) Population</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html#laser-simulation">LASER Simulation</a><ul>
<li class="toctree-l5"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html#laser-masking-approach-to-study-energy-transfer-using-rt-tddft-approach"><strong>LASER Masking approach to study energy transfer using RT-TDDFT approach</strong></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/algorithm/simulations/simulations.html#references">References</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/algorithm/surface_hopping/surface_hopping.html">Trajectory Surface Hopping (upcoming)</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/algorithm/spin_orbit/spin_orbit.html">Effects of spin-orbit interactions (upcoming)</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/algorithm/qm_mm/qm_mm.html">RT-TDDFT with QM/MM method (upcoming)</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/algorithm/normal_mode/normal_mode.html">Normal Mode analysis (upcoming)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="feature_and_implementations/independent_tasks/independent_tasks.html"><strong>Independent Tasks Based</strong></a><ul>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/independent_tasks/gs/gs.html">Ground State</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/gs/gs.html#basic">Basic</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/gs/gs.html#convergence">Convergence</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/gs/gs.html#advanced">Advanced</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/independent_tasks/rt_tddft/rt_tddft.html">RT-TDDFT</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/rt_tddft/rt_tddft.html#delta-kick-inputs">Delta kick Inputs</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/rt_tddft/rt_tddft.html#laser-design-tools">Laser Design tools</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/rt_tddft/rt_tddft.html#laser-design">Laser design</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/rt_tddft/rt_tddft.html#masking">Masking</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/rt_tddft/rt_tddft.html#properties">Properties</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/independent_tasks/compute_spectrum/compute_spectrum.html">Compute Spectrum</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/independent_tasks/post_processing_and_visualization/post_processing_and_visualization.html">Post processing and visualization</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/post_processing_and_visualization/dipole_moment_analysis.html">Dipole moment analysis</a></li>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/independent_tasks/post_processing_and_visualization/compute_tas.html">Compute TAS</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="feature_and_implementations/workflow/workflow.html"><strong>Workflows Based</strong></a><ul>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/workflow/spectrum/spectrum.html">Spectrum</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/workflow/averaged_spectrum/averaged_spectrum.html">Averaged Spectrum</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/workflow/ksd/ksd.html">KSD</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/workflow/ksd/ksd.html#compute-ksd">Compute KSD</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/workflow/mo_population/mo_population.html">Molecular Orbital (MO) Population</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feature_and_implementations/workflow/mo_population/mo_population.html#compute-mo-population">Compute MO Population</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/workflow/laser_masking/laser_masking.html">Laser-Masking</a></li>
<li class="toctree-l3"><a class="reference internal" href="feature_and_implementations/workflow/pump_probe/pump_probe.html">Pump-probe</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_documentation/user_documentation_index.html">User Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_documentation/create_open_project.html">Starting LITESOPH</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_documentation/create_open_project.html#create-a-new-project">Create a new Project</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_documentation/create_open_project.html#create-a-workflow">Create a Workflow</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/create_open_project.html#new-workflow">New Workflow</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/create_open_project.html#clone-from-an-existing-workflow">Clone from an existing Workflow</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_documentation/job_submission_monitoring.html">LITESOPH Job Submission, Monitoring and File Management</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/job_submission_monitoring.html#overview">Overview</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/job_submission_monitoring.html#features-and-functionalities">Features and Functionalities</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/job_submission_monitoring.html#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_documentation/visualization_toolkit.html">LITESOPH Visualization Toolkit</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/visualization_toolkit.html#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user_documentation/Parameters.html">Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/Parameters.html#charge">Charge</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/Parameters.html#multiplicity">Multiplicity</a></li>
<li class="toctree-l3"><a class="reference internal" href="user_documentation/Parameters.html#environment">Environment</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples/examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/gpaw/gpaw.html">TDDFT calculations using GPAW</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples/gpaw/gpaw.html#results-for-na8-chain-using-gui-for-gpaw-engine">Results for Na8 Chain using GUI for GPAW Engine</a><ul>
<li class="toctree-l4"><a class="reference internal" href="examples/gpaw/gpaw.html#spectrum-analysis">Spectrum Analysis</a></li>
<li class="toctree-l4"><a class="reference internal" href="examples/gpaw/gpaw.html#transition-contribution-map-tcm">Transition Contribution Map (TCM)</a></li>
<li class="toctree-l4"><a class="reference internal" href="examples/gpaw/gpaw.html#population-evolution">Population Evolution</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="examples/Octopus_Calculation.html">TDDFT calculations using Octopus</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples/Octopus_Calculation.html#input-file-description">Input File Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples/Octopus_Calculation.html#spectrum-analysis">Spectrum Analysis</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="examples/NWChem_Calculation.html">TDDFT calculations using NWChem</a><ul>
<li class="toctree-l3"><a class="reference internal" href="examples/NWChem_Calculation.html#input-file-description">Input File Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="examples/NWChem_Calculation.html#spectrum-analysis">Spectrum Analysis</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="devel/devel.html">Development</a><ul>
<li class="toctree-l2"><a class="reference internal" href="devel/developer_workflow.html">Development workflow</a><ul>
<li class="toctree-l3"><a class="reference internal" href="devel/developer_workflow.html#setting-up-your-local-repository">Setting up your local repository</a></li>
<li class="toctree-l3"><a class="reference internal" href="devel/developer_workflow.html#setting-up-your-development-environment">Setting up your development environment</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/developer_workflow.html#conda-environment">Conda environment</a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/developer_workflow.html#python-venv-environment">Python venv environment</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/developer_workflow.html#coding-standards">Coding Standards</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="devel/devel.html#development-topics">Development topics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="devel/engine.html">Adding new engine</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/engine.html#description-of-base-classes">Description of base-classes</a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/engine.html#the-engine-base-classes">The Engine base-classes</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/engine.html#litesoph.engines.engine_classname"><code class="docutils literal notranslate"><span class="pre">engine_classname</span></code></a></li>
<li class="toctree-l6"><a class="reference internal" href="devel/engine.html#litesoph.common.engine_manager.EngineManager"><code class="docutils literal notranslate"><span class="pre">EngineManager</span></code></a><ul>
<li class="toctree-l7"><a class="reference internal" href="devel/engine.html#litesoph.common.engine_manager.EngineManager.get_task"><code class="docutils literal notranslate"><span class="pre">EngineManager.get_task()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/engine.html#litesoph.common.engine_manager.EngineManager.get_default_task_param"><code class="docutils literal notranslate"><span class="pre">EngineManager.get_default_task_param()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/engine.html#litesoph.common.engine_manager.EngineManager.get_task_list"><code class="docutils literal notranslate"><span class="pre">EngineManager.get_task_list()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/engine.html#litesoph.common.engine_manager.EngineManager.get_workflow_list"><code class="docutils literal notranslate"><span class="pre">EngineManager.get_workflow_list()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/engine.html#litesoph.common.engine_manager.EngineManager.check_task"><code class="docutils literal notranslate"><span class="pre">EngineManager.check_task()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/task.html">Adding new task</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/task.html#description-of-base-classes">Description of base-classes</a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/task.html#the-task-base-classes">The Task base-classes</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/task.html#litesoph.common.Task"><code class="docutils literal notranslate"><span class="pre">Task</span></code></a><ul>
<li class="toctree-l7"><a class="reference internal" href="devel/task.html#litesoph.common.Task.create_template"><code class="docutils literal notranslate"><span class="pre">Task.create_template()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/task.html#litesoph.common.Task.write_input"><code class="docutils literal notranslate"><span class="pre">Task.write_input()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/task.html#litesoph.common.Task.create_job_script"><code class="docutils literal notranslate"><span class="pre">Task.create_job_script()</span></code></a></li>
<li class="toctree-l7"><a class="reference internal" href="devel/task.html#litesoph.common.Task.add_proper_path"><code class="docutils literal notranslate"><span class="pre">Task.add_proper_path()</span></code></a></li>
</ul>
</li>
<li class="toctree-l6"><a class="reference internal" href="devel/task.html#litesoph.common.task_data.TaskTypes"><code class="docutils literal notranslate"><span class="pre">TaskTypes</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/workflow.html">Adding new workflow type</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/workflow.html#litesoph.common.workflows_data.WorkflowTypes"><code class="docutils literal notranslate"><span class="pre">WorkflowTypes</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/workflow.html#litesoph.common.workflows_data.predefined_workflow"><code class="docutils literal notranslate"><span class="pre">predefined_workflow</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="devel/devel.html#code-overview">Code overview</a><ul>
<li class="toctree-l3"><a class="reference internal" href="devel/architecture.html">Code Architecture</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/architecture.html#litesoph.common.ls_manager.LSManager"><code class="docutils literal notranslate"><span class="pre">LSManager</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.ls_manager.LSManager.new_project"><code class="docutils literal notranslate"><span class="pre">LSManager.new_project()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.ls_manager.LSManager.open_project"><code class="docutils literal notranslate"><span class="pre">LSManager.open_project()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.ls_manager.LSManager.read_config"><code class="docutils literal notranslate"><span class="pre">LSManager.read_config()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager"><code class="docutils literal notranslate"><span class="pre">ProjectManager</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.clone_workflow"><code class="docutils literal notranslate"><span class="pre">ProjectManager.clone_workflow()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.get_workflow_info"><code class="docutils literal notranslate"><span class="pre">ProjectManager.get_workflow_info()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.list"><code class="docutils literal notranslate"><span class="pre">ProjectManager.list()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.list_available_workflows"><code class="docutils literal notranslate"><span class="pre">ProjectManager.list_available_workflows()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.new_workflow"><code class="docutils literal notranslate"><span class="pre">ProjectManager.new_workflow()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.open_workflow"><code class="docutils literal notranslate"><span class="pre">ProjectManager.open_workflow()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.remove"><code class="docutils literal notranslate"><span class="pre">ProjectManager.remove()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.project_manager.ProjectManager.start_workflow"><code class="docutils literal notranslate"><span class="pre">ProjectManager.start_workflow()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager"><code class="docutils literal notranslate"><span class="pre">WorkflowManager</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.add_block"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.add_block()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.add_dependency"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.add_dependency()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.add_task"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.add_task()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.check_engine"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.check_engine()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.choose_default_engine"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.choose_default_engine()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.clone"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.clone()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.get_engine_task"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.get_engine_task()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.get_task_dependencies"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.get_task_dependencies()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.get_taskinfo"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.get_taskinfo()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.next"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.next()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.save"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.save()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="devel/architecture.html#litesoph.common.workflow_manager.WorkflowManager.set_engine"><code class="docutils literal notranslate"><span class="pre">WorkflowManager.set_engine()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="devel/architecture.html#litesoph.common.data_sturcture.data_classes.ProjectInfo"><code class="docutils literal notranslate"><span class="pre">ProjectInfo</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/architecture.html#litesoph.common.data_sturcture.data_classes.WorkflowInfo"><code class="docutils literal notranslate"><span class="pre">WorkflowInfo</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/architecture.html#litesoph.common.data_sturcture.data_classes.TaskInfo"><code class="docutils literal notranslate"><span class="pre">TaskInfo</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/job_submission_monitoring.html">LITESOPH Job Submission, Monitoring and File Management</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/job_submission_monitoring.html#features">Features</a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/job_submission_monitoring.html#functionalities">Functionalities</a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/job_submission_monitoring.html#modules-functions-and-working">Modules, Functions and Working</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/visualization_toolkit.html">LITESOPH Visualization Toolkit</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/visualization_toolkit.html#modules-functions-and-working">Modules, Functions and Working</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/gui_view.html">GUI View Modules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/gui_view.html#modules-under-litesoph">Modules under LITESOPH</a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/gui_view.html#class-view">Class View</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_view.html#functionalities">Functionalities</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="devel/gui_view.html#class-inputframe">Class InputFrame</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_view.html#parameters">Parameters</a></li>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_view.html#id1">Functionalities</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="devel/gui_view.html#usage">Usage</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_view.html#creating-a-new-gui-frame">Creating a new GUI frame</a></li>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_view.html#updating-the-existing-frames">Updating the existing frames</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="devel/gui_view.html#visual-parameters-modules">Visual Parameters Modules</a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/gui_view.html#id2">Functionalities</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="devel/gui_control.html">GUI Control Modules</a><ul>
<li class="toctree-l4"><a class="reference internal" href="devel/gui_control.html#features-and-functionalities">Features and Functionalities</a></li>
<li class="toctree-l4"><a class="reference internal" href="devel/gui_control.html#modules-under-litesoph">Modules under LITESOPH</a><ul>
<li class="toctree-l5"><a class="reference internal" href="devel/gui_control.html#class-taskcontroller">Class TaskController</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_control.html#relevant-methods">Relevant Methods</a></li>
</ul>
</li>
<li class="toctree-l5"><a class="reference internal" href="devel/gui_control.html#usage">Usage</a><ul>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_control.html#defining-a-taskcontroller">Defining a TaskController</a></li>
<li class="toctree-l6"><a class="reference internal" href="devel/gui_control.html#remarks">Remarks</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="FAQs/FAQ.html">Frequently Asked Questions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="FAQs/FAQ.html#how-to-enable-passwordless-ssh">How to enable passwordless SSH?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Bugs.html">Bugs!</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_notes.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_notes.html#v1-1-beta">V1.1 (Beta)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#workflow-mode-enhancements">Workflow Mode Enhancements:</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#task-mode-updates">Task Mode Updates:</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#user-interface-and-usability-improvements">User Interface and Usability Improvements:</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#documentation-and-support">Documentation and Support:</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes.html#future-updates">Future Updates:</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="people.html">Team Litesoph</a><ul>
<li class="toctree-l2"><a class="reference internal" href="people.html#investigators"><strong>Investigators</strong></a><ul>
<li class="toctree-l3"><a class="reference internal" href="people.html#current-developers"><strong>Current Developers</strong></a></li>
<li class="toctree-l3"><a class="reference internal" href="people.html#past-contributors"><strong>Past contributors</strong></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="about_LITESOPH.html" class="btn btn-neutral float-right" title="About LITESOPH" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, LITESOPH members and team.
<span class="lastupdated">Last updated on Mon, 20 May 2024 09:06:43.
</span></p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>