mirror of
https://github.com/LCPQ/quantum_package
synced 2024-08-25 05:51:46 +02:00
Add doc
This commit is contained in:
parent
bfde4f47c9
commit
0e6e008b23
42
doc/code_architecture/Script.md
Normal file
42
doc/code_architecture/Script.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
# `ei_handler.py`
|
||||||
|
|
||||||
|
This script in located in `$QPACKAGE_ROOT/scripts/ezfio_interface/`.
|
||||||
|
It provide all the resource need to deal with the `EZFIO.cfg` files :
|
||||||
|
- The creation of `$MODULE_LOWER_ezfio_config` in `$QPACKAGE_ROOT/ezfio/config`
|
||||||
|
- The `ezfio_interface.irp.f` who containt all the provider associate (in `$MODULE/`)
|
||||||
|
- The `$MODULE_LOWER_ezfio_defaults` in `$QPACKAGE_ROOT/data/`
|
||||||
|
- The `Input_$MODULE_LOWER.ml` for the *qp_edit*
|
||||||
|
|
||||||
|
For more information you can type `ei_handler.py -h`
|
||||||
|
|
||||||
|
# `module_handler.py`
|
||||||
|
|
||||||
|
This script in located in `$QPACKAGE_ROOT/scripts/module/`.
|
||||||
|
It provide all the resource related to the tree dependancy of the modules.
|
||||||
|
If more useful as a librairy than a cli.
|
||||||
|
|
||||||
|
It have some usefull property:
|
||||||
|
- The list of module
|
||||||
|
- The dict of the descendant
|
||||||
|
- The dict of the parent
|
||||||
|
- The dict of the child
|
||||||
|
- The dict of the root
|
||||||
|
- The list reduced tree (For a list of module in input return only the root)
|
||||||
|
|
||||||
|
In the cli mode:
|
||||||
|
- From a `NEEDED_CHILDREN_MODULE` file you can have all the descendant, and a png
|
||||||
|
representation who correspond.
|
||||||
|
|
||||||
|
|
||||||
|
# `qp_install_module.py`
|
||||||
|
This script is located in `$QPACKAGE_ROOT/scripts/module/`.
|
||||||
|
|
||||||
|
It is usefull when you need to install a new module. (From the soon to come repo or from scratch).
|
||||||
|
|
||||||
|
# `qp_create_ninja.py`
|
||||||
|
|
||||||
|
This script is located in `$QPACKAGE_ROOT/scripts/compilation/`.
|
||||||
|
It will create the `build.ninja` file. It will use intersifly the `module_handler.py` module.
|
||||||
|
|
||||||
|
To read all the flag for the compilation the module `read_compilation_cfg.py` is used.
|
||||||
|
You only need to know, that all flag are appending.
|
@ -8,7 +8,6 @@ of a NEEDED_CHILDREN_MODULES file
|
|||||||
Usage:
|
Usage:
|
||||||
module_handler.py print_descendant [<NEEDED_CHILDREN_MODULES>]
|
module_handler.py print_descendant [<NEEDED_CHILDREN_MODULES>]
|
||||||
module_handler.py create_png [<NEEDED_CHILDREN_MODULES>]
|
module_handler.py create_png [<NEEDED_CHILDREN_MODULES>]
|
||||||
module_handler.py head_module
|
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
print_descendant Print the genealogy of the NEEDED_CHILDREN_MODULES
|
print_descendant Print the genealogy of the NEEDED_CHILDREN_MODULES
|
||||||
@ -140,7 +139,7 @@ class ModuleHandler:
|
|||||||
|
|
||||||
@classmethod
|
@classmethod
|
||||||
def l_reduce_tree(cls, l_module):
|
def l_reduce_tree(cls, l_module):
|
||||||
|
"""For a list of module in input return only the root"""
|
||||||
l_d_u = cls.l_descendant_unique(l_module)
|
l_d_u = cls.l_descendant_unique(l_module)
|
||||||
l_module_reduce = []
|
l_module_reduce = []
|
||||||
for module in l_module:
|
for module in l_module:
|
||||||
|
@ -1,8 +1,12 @@
|
|||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
"""
|
"""
|
||||||
Usage: qp_create_module.py list
|
Usage: qp_install_module.py list
|
||||||
qp_create_module.py create -n <name> [<children_module>...]
|
qp_install_module.py create -n <name> [<children_module>...]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
list: List all the module avalaible
|
||||||
|
create: Create a new module
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import sys
|
import sys
|
Loading…
Reference in New Issue
Block a user