diff --git a/dist/kadmos-0.6.dev0-py2-none-any.whl b/dist/kadmos-0.6.dev0-py2-none-any.whl index 40674589c7dca29d002f468277a042c00c29fb74..92982a9b136ca6ac68304ab6949c219c7478711a 100644 Binary files a/dist/kadmos-0.6.dev0-py2-none-any.whl and b/dist/kadmos-0.6.dev0-py2-none-any.whl differ diff --git a/dist/kadmos-0.6.dev0.tar.gz.REMOVED.git-id b/dist/kadmos-0.6.dev0.tar.gz.REMOVED.git-id index a14027f0649d10c2b4189b78c016178a3b29f426..3c36813c27a524ccf7d0e67ae954e323e009f493 100644 --- a/dist/kadmos-0.6.dev0.tar.gz.REMOVED.git-id +++ b/dist/kadmos-0.6.dev0.tar.gz.REMOVED.git-id @@ -1 +1 @@ -740f4a41e3444a089d960ed6e590afa6294af563 \ No newline at end of file +93355ed501571284634e1bbb182a3e959d609b43 \ No newline at end of file diff --git a/doc/.doctrees/KADMOS.doctree b/doc/.doctrees/KADMOS.doctree index 48899a673bbcb5aa02749d8a05c02c4d2f187b78..9e802dbe079898071fab38f62d349791712a74b1 100644 Binary files a/doc/.doctrees/KADMOS.doctree and b/doc/.doctrees/KADMOS.doctree differ diff --git a/doc/.doctrees/environment.pickle b/doc/.doctrees/environment.pickle index c3f8e31ffced08ad75ddf515029d108eb19368d1..9db0f37d3d95a826f27eb268562c4ca904c641cd 100644 Binary files a/doc/.doctrees/environment.pickle and b/doc/.doctrees/environment.pickle differ diff --git a/doc/KADMOS.html b/doc/KADMOS.html index c7ce914b4fcddc8399cfe86cfa54ff2ff198a1c6..4178b69fb2eac8be61a722246379d74ab44f07af 100644 --- a/doc/KADMOS.html +++ b/doc/KADMOS.html @@ -55,14 +55,12 @@ </div> <div class="section" id="module-kadmos"> <span id="documentation-for-the-code"></span><h1>Documentation for the Code<a class="headerlink" href="#module-kadmos" title="Permalink to this headline">¶</a></h1> -<p>Below the main class diagram of the KADMOS package is shown.</p> -<a class="reference internal image-reference" href="_images/KADMOS_UMLs.png"><img alt="_images/KADMOS_UMLs.png" class="align-center" src="_images/KADMOS_UMLs.png" style="width: 70%;" /></a> -<p>Example scripts for using KADMOS are available in the scripts folder. The following scripts are available there:</p> +<p>Below the simplified class diagram of the KADMOS package is shown (not all methods are included for clarity).</p> +<a class="reference internal image-reference" href="_images/KADMOS_UML.png"><img alt="_images/KADMOS_UML.png" class="align-center" src="_images/KADMOS_UML.png" style="width: 70%;" /></a> +<p>Example scripts for using KADMOS are available in the examples/scripts folder. The following scripts are available there:</p> <ul class="simple"> -<li><code class="docutils literal"><span class="pre">sellarProblem.py</span></code>: Small two-disciplinary MDO problem based on MDO literature.</li> -<li><code class="docutils literal"><span class="pre">AGILE_EY01_DEMO.py</span></code>: Small-size MDO problem inspired on CPACS data schema.</li> -<li><code class="docutils literal"><span class="pre">mathProblem.py</span></code>: User-adjustable (in size and coupling strength) MDO problem based on MDO literature.</li> -<li><code class="docutils literal"><span class="pre">exampleGraphs.py</span></code>: Script that combines different example scripts and provides graphs that can be used for visualization.</li> +<li><code class="docutils literal"><span class="pre">Sellar</span> <span class="pre">Problem</span></code>: Small two-disciplinary MDO problem based on MDO literature.</li> +<li><code class="docutils literal"><span class="pre">TU</span> <span class="pre">Delft</span> <span class="pre">Wing</span> <span class="pre">Design</span></code>: The wing design case descirbed here was developed at TU Delft and takes a variety of different diciplines into account.</li> </ul> <div class="section" id="knowledgebase"> <h2>KnowledgeBase<a class="headerlink" href="#knowledgebase" title="Permalink to this headline">¶</a></h2> @@ -558,7 +556,7 @@ node or edge attributes.</p> <dl class="method"> <dt id="kadmos.graph.KadmosGraph.create_dsm"> -<code class="descname">create_dsm</code><span class="sig-paren">(</span><em>file_name</em>, <em>destination_folder=None</em>, <em>open_pdf=False</em>, <em>mpg=None</em>, <em>include_system_vars=True</em>, <em>summarize_vars=False</em>, <em>function_order=None</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.graph.KadmosGraph.create_dsm" title="Permalink to this definition">¶</a></dt> +<code class="descname">create_dsm</code><span class="sig-paren">(</span><em>file_name</em>, <em>destination_folder=None</em>, <em>open_pdf=False</em>, <em>mpg=None</em>, <em>include_system_vars=True</em>, <em>summarize_vars=False</em>, <em>function_order=None</em>, <em>keep_tex_file=False</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.graph.KadmosGraph.create_dsm" title="Permalink to this definition">¶</a></dt> <dd><p>Method to create a (X)DSM PDF file</p> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> @@ -572,6 +570,7 @@ node or edge attributes.</p> <li><strong>include_system_vars</strong> (<em>bool</em>) – option for including system variables (only applicable for DSMs)</li> <li><strong>summarize_vars</strong> (<em>bool</em>) – option for summarizing label</li> <li><strong>function_order</strong> (<em>list</em>) – optional function order for the diagonal of the graph (only applicable for DSMs)</li> +<li><strong>keep_tex_file</strong> (<em>bool</em>) – optional argument to keep the tex file of the PDF</li> </ul> </td> </tr> @@ -2388,7 +2387,7 @@ the original graph (this changes the original graph).</dd> <dl class="method"> <dt id="kadmos.graph.KadmosGraph.save"> -<code class="descname">save</code><span class="sig-paren">(</span><em>file_name</em>, <em>file_type='kdms'</em>, <em>graph_check_critical=True</em>, <em>destination_folder=None</em>, <em>mpg=None</em>, <em>description=''</em>, <em>creator=''</em>, <em>version='1.0'</em>, <em>timestamp=datetime.datetime(2017</em>, <em>6</em>, <em>26</em>, <em>13</em>, <em>14</em>, <em>52</em>, <em>265000)</em>, <em>keep_empty_elements=False</em>, <em>pretty_print=False</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.graph.KadmosGraph.save" title="Permalink to this definition">¶</a></dt> +<code class="descname">save</code><span class="sig-paren">(</span><em>file_name</em>, <em>file_type='kdms'</em>, <em>graph_check_critical=True</em>, <em>destination_folder=None</em>, <em>mpg=None</em>, <em>description=''</em>, <em>creator=''</em>, <em>version='1.0'</em>, <em>timestamp=datetime.datetime(2017</em>, <em>7</em>, <em>24</em>, <em>11</em>, <em>14</em>, <em>6</em>, <em>687000)</em>, <em>keep_empty_elements=False</em>, <em>pretty_print=False</em><span class="sig-paren">)</span><a class="headerlink" href="#kadmos.graph.KadmosGraph.save" title="Permalink to this definition">¶</a></dt> <dd><p>Method to save the graph.</p> <p>Different output file types are implemented for saving graphs. They are listed in the following. kdms: the most simple file type which makes use of pickling diff --git a/doc/_images/KADMOS_UML.png b/doc/_images/KADMOS_UML.png new file mode 100644 index 0000000000000000000000000000000000000000..a6c0ec369823b901331135c106f335484b5ed23f Binary files /dev/null and b/doc/_images/KADMOS_UML.png differ diff --git a/doc/_sources/KADMOS.txt b/doc/_sources/KADMOS.txt index 236d62ae5ed30dfe49afd5cc5b7e4c2fd8cef1b5..3bf46ac3e47244c907334c76b39e3165056c19fd 100644 --- a/doc/_sources/KADMOS.txt +++ b/doc/_sources/KADMOS.txt @@ -17,18 +17,16 @@ Documentation for the Code .. automodule:: kadmos -Below the main class diagram of the KADMOS package is shown. +Below the simplified class diagram of the KADMOS package is shown (not all methods are included for clarity). -.. image:: ../doc_source/images/KADMOS_UMLs.png +.. image:: ../doc_source/uml/KADMOS_UML.png :width: 70 % :align: center -Example scripts for using KADMOS are available in the scripts folder. The following scripts are available there: +Example scripts for using KADMOS are available in the examples/scripts folder. The following scripts are available there: -* ``sellarProblem.py``: Small two-disciplinary MDO problem based on MDO literature. -* ``AGILE_EY01_DEMO.py``: Small-size MDO problem inspired on CPACS data schema. -* ``mathProblem.py``: User-adjustable (in size and coupling strength) MDO problem based on MDO literature. -* ``exampleGraphs.py``: Script that combines different example scripts and provides graphs that can be used for visualization. +* ``Sellar Problem``: Small two-disciplinary MDO problem based on MDO literature. +* ``TU Delft Wing Design``: The wing design case descirbed here was developed at TU Delft and takes a variety of different diciplines into account. KnowledgeBase ************* diff --git a/doc/searchindex.js b/doc/searchindex.js index 0f1496b55f4b8a5d4ef372dad4dab5f390b4684c..b10c79ad346a81db8fc047e12b551e05f142e10e 100644 --- a/doc/searchindex.js +++ b/doc/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:46,filenames:["KADMOS"],objects:{"":{kadmos:[0,0,0,"-"]},"kadmos.graph":{FundamentalProblemGraph:[0,3,1,""],KadmosGraph:[0,3,1,""],MdaoDataGraph:[0,3,1,""],MdaoProcessGraph:[0,3,1,""],RepositoryConnectivityGraph:[0,3,1,""]},"kadmos.graph.FundamentalProblemGraph":{add_function_problem_roles:[0,1,1,""],cleancopy:[0,1,1,""],create_mdg:[0,1,1,""],create_mpg:[0,1,1,""],get_coupling_matrix:[0,1,1,""],get_mdg:[0,1,1,""],get_mg_function_ordering:[0,1,1,""],get_mpg:[0,1,1,""],mark_as_constraint:[0,1,1,""],mark_as_design_variable:[0,1,1,""],mark_as_objective:[0,1,1,""],mark_as_qoi:[0,1,1,""]},"kadmos.graph.KadmosGraph":{add_cycle:[0,1,1,""],add_edge:[0,1,1,""],add_edges_from:[0,1,1,""],add_node:[0,1,1,""],add_nodes_from:[0,1,1,""],add_objective_function_by_nodes:[0,1,1,""],add_path:[0,1,1,""],add_star:[0,1,1,""],add_weighted_edges_from:[0,1,1,""],adjacency_iter:[0,1,1,""],adjacency_list:[0,1,1,""],adjlist_dict_factory:[0,4,1,""],check:[0,1,1,""],check_cmdows_integrity:[0,1,1,""],check_for_coupling:[0,1,1,""],cleancopy:[0,1,1,""],clear:[0,1,1,""],copy:[0,1,1,""],copy_node_with_suffix:[0,1,1,""],count_function_nodes:[0,1,1,""],create_dsm:[0,1,1,""],degree:[0,1,1,""],degree_iter:[0,1,1,""],disconnect_problematic_variables_from:[0,1,1,""],edge_attr_dict_factory:[0,4,1,""],edges:[0,1,1,""],edges_iter:[0,1,1,""],expand_node:[0,1,1,""],find_all_nodes:[0,1,1,""],get_adjacency_matrix:[0,1,1,""],get_categorized_nodes:[0,1,1,""],get_contracted_graph:[0,1,1,""],get_direct_coupling_nodes:[0,1,1,""],get_edge_data:[0,1,1,""],get_function_graph:[0,1,1,""],get_function_metadata:[0,1,1,""],get_function_nodes:[0,1,1,""],get_graph_properties:[0,1,1,""],get_node_attributes:[0,1,1,""],get_node_subcategory:[0,1,1,""],get_nodes_based_on_strings:[0,1,1,""],get_nodes_indegree:[0,1,1,""],get_nodes_outdegree:[0,1,1,""],get_nodes_subcategory:[0,1,1,""],get_number_of_couplings:[0,1,1,""],get_partitioned_graph:[0,1,1,""],get_sources:[0,1,1,""],get_subgraph_by_function_nodes:[0,1,1,""],get_system_inputs:[0,1,1,""],get_targets:[0,1,1,""],has_edge:[0,1,1,""],has_node:[0,1,1,""],has_nodes:[0,1,1,""],has_predecessor:[0,1,1,""],has_successor:[0,1,1,""],in_degree:[0,1,1,""],in_degree_iter:[0,1,1,""],in_edges:[0,1,1,""],in_edges_iter:[0,1,1,""],inspect:[0,1,1,""],inspect_node:[0,1,1,""],inspect_nodes:[0,1,1,""],is_directed:[0,1,1,""],is_multigraph:[0,1,1,""],make_all_variables_valid:[0,1,1,""],merge_function_modes:[0,1,1,""],merge_function_nodes_based_on_modes:[0,1,1,""],merge_parallel_functions:[0,1,1,""],merge_sequential_functions:[0,1,1,""],nbunch_iter:[0,1,1,""],neighbors:[0,1,1,""],neighbors_iter:[0,1,1,""],node_dict_factory:[0,4,1,""],node_is_function:[0,1,1,""],node_is_hole:[0,1,1,""],node_is_objective_function:[0,1,1,""],node_is_output:[0,1,1,""],node_is_variable:[0,1,1,""],nodes:[0,1,1,""],nodes_iter:[0,1,1,""],nodes_with_selfloops:[0,1,1,""],number_of_edges:[0,1,1,""],number_of_nodes:[0,1,1,""],number_of_selfloops:[0,1,1,""],order:[0,1,1,""],out_degree:[0,1,1,""],out_degree_iter:[0,1,1,""],out_edges:[0,1,1,""],out_edges_iter:[0,1,1,""],plot_adjacency_matrix:[0,1,1,""],plot_graph:[0,1,1,""],predecessors:[0,1,1,""],predecessors_iter:[0,1,1,""],print_graph:[0,1,1,""],remove_edge:[0,1,1,""],remove_edges_from:[0,1,1,""],remove_function_nodes:[0,1,1,""],remove_node:[0,1,1,""],remove_nodes_from:[0,1,1,""],reverse:[0,1,1,""],save:[0,1,1,""],select_objectives_from_graph:[0,1,1,""],selfloop_edges:[0,1,1,""],size:[0,1,1,""],split_variables:[0,1,1,""],subgraph:[0,1,1,""],successors:[0,1,1,""],successors_iter:[0,1,1,""],to_directed:[0,1,1,""],to_undirected:[0,1,1,""],vispack_add:[0,1,1,""],vispack_create:[0,1,1,""]},"kadmos.graph.MdaoDataGraph":{cleancopy:[0,1,1,""],connect_converger:[0,1,1,""],connect_coordinator:[0,1,1,""],connect_doe_block:[0,1,1,""],connect_nodes_as_output:[0,1,1,""],connect_optimizer:[0,1,1,""],connect_qoi_nodes_as_input:[0,1,1,""],copy_node_as:[0,1,1,""],manipulate_coupling_nodes:[0,1,1,""]},"kadmos.graph.MdaoProcessGraph":{add_parallel_process:[0,1,1,""],add_simple_sequential_process:[0,1,1,""],cleancopy:[0,1,1,""],connect_nested_iterators:[0,1,1,""],get_nested_process_ordering:[0,1,1,""],get_node_text:[0,1,1,""],get_process_list:[0,1,1,""],inspect_process:[0,1,1,""]},"kadmos.graph.RepositoryConnectivityGraph":{cleancopy:[0,1,1,""],get_fpg_based_on_function_nodes:[0,1,1,""],get_fpg_based_on_list_functions:[0,1,1,""],get_fpg_based_on_sinks:[0,1,1,""],get_fpg_by_function_nodes:[0,1,1,""],get_function_paths_by_objective:[0,1,1,""],get_path_combinations:[0,1,1,""],select_function_combination_from:[0,1,1,""]},"kadmos.utilities":{general:[0,0,0,"-"]},"kadmos.utilities.general":{color_list:[0,2,1,""],export_as_json:[0,2,1,""],format_string_for_d3js:[0,2,1,""],get_element_dict:[0,2,1,""],get_friendly_id:[0,2,1,""],get_list_entries:[0,2,1,""],get_mdao_setup:[0,2,1,""],get_schema:[0,2,1,""],get_unique_friendly_id:[0,2,1,""],hex_to_rgb:[0,2,1,""],make_camel_case:[0,2,1,""],make_plural:[0,2,1,""],open_file:[0,2,1,""],remove_if_exists:[0,2,1,""],string_eval:[0,2,1,""],test_attr_cond:[0,2,1,""],transform_data_into_strings:[0,2,1,""],transform_string_into_format:[0,2,1,""],unmake_camel_case:[0,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","function","Python function"],"3":["py","class","Python class"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:method","2":"py:function","3":"py:class","4":"py:attribute"},terms:{"1e4":0,"5pm":0,"__iter__":0,"__len__":0,"_check_category_a":0,"_check_category_b":0,"_check_category_c":0,"_ui_d":0,"boolean":0,"case":0,"class":0,"default":0,"export":0,"final":0,"float":0,"function":0,"int":0,"long":0,"new":0,"return":0,"true":0,"while":0,abl:0,abov:0,accord:0,action:0,actual:0,add:0,add_cycl:0,add_edg:0,add_edges_from:0,add_function_problem_rol:0,add_nod:0,add_nodes_from:0,add_nodes_subcategori:[],add_objective_function_by_nod:0,add_parallel_process:0,add_path:0,add_simple_sequential_process:0,add_star:0,add_to_visualization_packag:[],add_weighted_edges_from:0,addit:0,adj_it:0,adj_list:0,adjac:0,adjacency_it:0,adjacency_list:0,adjlist_dict_factori:0,adjust:0,advanc:0,after:0,agile_ey01_demo:0,aircraft:0,algorithm:0,alia:0,all:0,all_nod:0,allow:0,allow_unconverged_coupl:0,alreadi:0,also:0,alwai:0,american:0,amount:0,analys:0,analysi:0,analyz:0,ani:0,anoth:0,appear:0,append:0,appli:0,applic:0,arbitrari:0,architectur:0,architecture_rol:0,arg:0,argument:0,around:0,ask:0,assess:0,assign:0,associ:0,assum:0,attempt:0,attr:0,attr_cond:0,attr_dict:0,attr_exclud:0,attr_includ:0,attr_list:0,attr_valu:0,attrdict:0,attribut:0,attrnam:0,automat:0,avail:0,avoid:0,back:0,base:0,baselin:0,basestr:0,becaus:0,becom:0,been:0,befor:0,begin:[],belong:0,below:0,between:0,bitbucket:0,block:0,blue:0,bool:0,both:0,bound:0,box:0,build:[],call:0,camelcas:0,can:0,capac:0,care:0,categori:0,certain:0,chang:0,characterist:0,check:0,check_cmdows_integr:0,check_for_coupl:0,child:0,choic:0,choos:0,circular:0,clean:0,cleancopi:0,clear:0,close:0,clutter:0,cmdow:0,collect:0,collid:0,collis:0,color:0,color_list:0,color_set:0,combin:0,common:0,compar:0,complet:0,compon:0,compress:0,comput:0,condit:0,config:0,configur:0,connect:0,connect_converg:0,connect_coordin:0,connect_doe_block:0,connect_nested_iter:0,connect_nodes_as_output:0,connect_optim:0,connect_qoi_nodes_as_input:0,consid:0,consist:0,constraint:0,constraint_nod:0,construct:0,contain:0,content:0,contig:0,continu:0,contract:0,contracted_graph:0,contraction_level:0,contrast:0,control:0,conv_typ:0,conveni:0,converg:0,convert:0,coordin:0,copi:0,copy_node_a:0,copy_node_with_suffix:0,copy_typ:0,correct:0,corrupt:0,count:0,count_function_nod:0,coupl:0,coupling_funct:0,cpac:0,creat:0,create_dsm:0,create_mdg:0,create_mpg:0,create_visualization_packag:[],creation:[],creator:0,crete:0,criteria:0,cross:0,current:0,custom:0,cut:0,cwd:0,cycl:0,d3j:0,data:0,data_dictionari:0,databas:0,datadict:0,datavalu:0,datetim:0,ddict:0,deep:0,deepcopi:0,defin:0,degre:0,degree_it:0,delet:0,descend:0,descript:0,design:0,design_variable_nod:0,desir:0,destin:0,destination_fold:0,detail:0,determin:0,diagon:0,diagram:0,dict:0,dictionari:0,differ:0,digraph:0,dimens:0,direct:0,directli:0,directori:0,disciplinari:0,disconnect:0,disconnect_collided_target:0,disconnect_problematic_variables_from:0,disconnect_shared_sourc:0,disregard:0,distinguis:0,divid:0,doc:0,doe:0,doe_block:0,doesn:0,done:0,dont:0,draw:0,dsm:0,dtc:0,due:0,duplic:0,dynam:0,each:0,ebunch:0,edg:0,edge_attr_dict_factori:0,edge_dict:0,edge_ind:0,edge_it:0,edge_label:0,edge_list:0,edgelist:0,edges_it:0,edu:0,effect:0,either:0,element:0,empti:0,enabl:0,encount:0,end:0,end_in_converg:0,end_in_iterative_nod:0,end_nod:0,enrich:0,ensur:0,entri:0,entries_to_remov:0,equival:0,error:0,especi:0,etc:0,etre:0,evalu:0,even:0,everi:0,exampl:0,examplegraph:0,exce:0,except:0,exchang:0,exclud:0,exclus:0,execut:0,exhaust:0,exist:0,expand:0,expand_nod:0,expect:0,explicit:0,export_as_json:0,export_d3js_fil:[],express:0,extend:[],extend_list_uniqu:[],extens:0,extension_list:[],extract:0,fail:0,fals:0,faster:0,fastest:0,feedback:0,feedforward:0,fig_num:0,fig_siz:0,figur:0,file:0,file_nam:0,file_path:0,file_typ:0,filenam:0,filter:0,find:0,find_all_nod:0,finish:0,first:0,folder:0,follow:0,form:0,format:0,format_string_for_d3j:0,found:0,fpg:0,from:0,front:0,full:0,func_ord:0,function_ord:0,function_order_method:0,fundament:0,further:0,gauss:0,gener:0,get:0,get_adjacency_matrix:0,get_categorized_nod:0,get_contracted_graph:0,get_coupling_matrix:0,get_direct_coupling_nod:0,get_edge_data:0,get_element_dict:0,get_fpg_based_on_function_nod:0,get_fpg_based_on_list_funct:0,get_fpg_based_on_sink:0,get_fpg_by_function_nod:0,get_friendly_id:0,get_function_graph:0,get_function_metadata:0,get_function_nod:0,get_function_paths_by_object:0,get_graph_nodes_indegre:[],get_graph_nodes_outdegre:[],get_graph_properti:0,get_list_entri:0,get_mdao_setup:0,get_mdg:0,get_mg_function_ord:0,get_mpg:0,get_nested_process_ord:0,get_node_attribut:0,get_node_subcategori:0,get_node_text:0,get_nodes_based_on_str:0,get_nodes_indegre:0,get_nodes_outdegre:0,get_nodes_subcategori:0,get_number_of_coupl:0,get_partitioned_graph:0,get_path_combin:0,get_process_list:0,get_schema:0,get_sourc:0,get_subgraph_by_function_nod:0,get_system_input:0,get_target:0,get_unique_friendly_id:0,give:0,given:0,gkhome:0,glaro:0,graph_check_crit:0,graph_properti:0,graphml:0,group:0,guarante:0,guess:0,handl:0,has_edg:0,has_nod:0,has_predecessor:0,has_successor:0,hash:0,hashabl:0,have:0,hello:0,hex:0,hex_to_rgb:0,highest:0,hold:0,hole:0,how:0,howev:0,html:0,http:0,ident:0,idf:0,ignor:0,ignore_func:0,illustr:0,implement:0,in_degre:0,in_degree_it:0,in_edg:0,in_edge_it:0,in_edges_it:0,includ:0,include_al:0,include_couplings_as_final_output:0,include_reference_data:0,include_system_var:0,incom:0,indegre:0,indent:0,independ:0,index:0,indic:0,induc:0,inform:0,initi:0,inplac:0,input:0,input_list:0,inputless:0,insid:0,inspect:0,inspect_nod:0,inspect_process:0,inspir:0,integ:0,integr:0,interest:0,interfac:[],invalid:0,is_direct:0,is_multigraph:0,italian:0,item:0,iter:0,iterative_nod:0,itertool:0,itself:0,jacobi:0,japanes:0,json:0,just:0,kdm:0,keep:0,keep_empty_el:0,keep_objective_vari:0,kei:0,kept:0,keyerror:0,keys_to_be_remov:0,keyword:0,kwarg:0,label:0,label_extens:0,larg:0,last:0,lead:0,least:0,len:0,length:0,less:0,let:0,level:0,librari:0,like:0,limit:0,link:0,list:0,list_of_funct:0,list_of_nod:0,list_of_sink:0,literatur:0,load:0,local:0,log:0,look:0,loop:0,lost:0,lower:0,lower_bound:0,lowest:0,main:0,mainli:0,make:0,make_all_variables_valid:0,make_camel_cas:0,make_plur:0,make_plural_opt:0,mani:0,manipul:0,manipulate_coupling_nod:0,manual:0,mark:0,mark_as_constraint:0,mark_as_design_vari:0,mark_as_object:0,mark_as_qoi:0,master:0,match:0,mathproblem:0,matplotlib:0,matrix:0,max_func:0,maximum:0,mda:0,mda_typ:0,mdao:0,mdao_setup:0,mdf:0,mdg:0,mdo:0,mdo_architectur:0,meet:0,membership:0,merg:0,merge_func:0,merge_function_mod:0,merge_function_nodes_based_on_mod:0,merge_parallel_funct:0,merge_sequential_funct:0,merger:0,metadata:0,method:0,meti:0,mg_function_ord:0,middl:0,might:0,min_func:0,mind:0,minimum:0,mode:0,modifi:0,modul:0,more:0,most:0,move:[],move_and_open:[],mpg:0,multidigraph:0,multigraph:0,multipl:0,must:0,mutabl:0,my_obj_fcn_nam:0,mygraph:0,n_part:0,name:0,named_obj_fcn:0,nativ:0,nbrdict:0,nbunch:0,nbunch_it:0,nd_iter:0,nedg:0,need:0,neighbor:0,neighbors_it:0,nest:0,nested_funct:0,networkx:0,networkxerror:0,new_label:0,niter:0,nlist:0,nloop:0,nnode:0,no_circleview_variables_data:[],node:0,node_dict_factori:0,node_id:0,node_is_funct:0,node_is_hol:0,node_is_objective_funct:0,node_is_output:0,node_is_vari:0,node_nam:0,nodelist:0,nodes_it:0,nodes_with_selfloop:0,nomin:0,nominal_valu:0,non:0,none:0,nonetyp:0,normal:0,notat:0,note:0,number:0,number_of_edg:0,number_of_nod:0,number_of_selfloop:0,numer:0,obj_vars_cov:0,object:0,objective_nod:0,obtain:0,off:0,onc:0,onli:0,only_feedback:0,open:0,open_fil:0,open_pdf:0,oper:0,optim:0,option:0,order:0,org:0,origin:0,original_list:[],other:0,otherwis:0,our:0,out:0,out_degre:0,out_degree_it:0,out_edg:0,out_edges_it:0,outdegre:0,outgo:0,output:0,outputless:0,over:0,overal:0,overrid:0,override_with_final_output:0,overview:0,own:0,packag:0,page:0,pair:0,parallel:0,parallel_funct:0,param:0,paramet:0,part:0,partit:0,pass:0,path:0,paus:0,pdf:0,perform:0,pickl:0,place:0,platform:0,plot:0,plot_adjacency_matrix:0,plot_graph:0,plural:0,point:0,posit:0,possibl:0,post:0,pre:0,preced:0,predecessor:0,predecessors_it:0,prefix:0,presenc:0,present:0,pretti:0,pretty_print:0,print:0,print_attribut:0,print_coupl:0,print_graph:0,print_in_log:0,problem:0,problemat:0,process:0,process_info:0,produc:0,product:0,progress_path:[],prompt:0,properti:0,provid:0,psg:0,pull:0,pure:0,purpos:0,pymerg:0,pyplot:0,python:0,qoi:0,qoi_nod:0,quantiti:0,queri:0,quietli:0,rais:0,raise_error:0,raise_error_if_tru:0,rang:0,rce:0,read:0,readabl:0,reciproc:0,recognis:0,recurs:0,reduc:0,reduct:0,refer:0,reference_fil:0,refin:0,reflect:0,rel:0,relev:0,remain:0,remov:0,remove_after_compress:0,remove_edg:0,remove_edges_from:0,remove_feedback:0,remove_feedforward:0,remove_function_nod:0,remove_if_exist:0,remove_nod:0,remove_nodes_from:0,replac:0,replacement_index:0,repres:0,represent:0,request:0,requir:0,resolv:0,resourc:0,respect:0,result:0,retriev:0,revers:0,rgb:0,right:0,role:0,routin:0,run:0,runtim:0,safe:0,same:0,sampl:0,sampledir:0,samplefil:0,satisfi:0,save:0,save_a:0,schema:0,script:0,search:0,second:0,see:0,seidel:0,select:0,select_function_combination_from:0,select_objectives_from_graph:0,self:0,selfloop:0,selfloop_edg:0,sellarproblem:0,separ:0,sequenc:0,sequenti:0,set:0,sever:0,shallow:0,share:0,should:0,show:0,show_now:0,shown:0,sidebar:0,signific:0,silent:0,similar:0,simpl:0,simpler:0,simpli:0,sinc:0,singl:0,sink:0,size:0,slash:[],slave:0,small:0,some:0,sort:0,sort_bi:0,sort_kei:0,sourc:0,space:0,specif:0,specifi:0,split:0,split_all_vari:[],split_vari:0,splittabl:0,standard:0,star:0,start:0,start_nod:0,start_step:0,statement:0,step:0,still:0,store:0,str:0,strength:0,string:0,string_ev:0,structur:0,sub:0,subcategori:0,subclass:0,subdirectori:[],subfold:[],subgraph:0,subset:0,successor:0,successors_it:0,suffix:0,suit:0,sum:0,summar:0,summarize_var:0,suppli:0,sure:0,symbol:0,syntax:0,system:0,system_input:0,tabl:0,take:0,taken:0,target:0,temporari:0,test:0,test_attr_cond:0,test_valu:0,text:0,thei:0,them:0,therefor:0,thi:0,think:0,third:0,those:0,though:0,three:0,through:0,thu:0,time:0,timestamp:0,titl:0,to_direct:0,to_undirect:0,todo:0,togeth:0,tool:0,total:0,tpwgt:0,transfer:0,transform:0,transform_data_into_str:0,transform_string_into_format:0,translat:0,tree:0,tupl:0,twice:0,two:0,type:0,uid_length:0,umn:0,unconnect:0,underscor:0,undirect:0,uniqu:0,unmake_camel_cas:0,unnamed_funct:0,unpack:0,until:0,unwant:0,updat:0,upper:0,upper_bound:0,usag:0,use_d3js_node_id:0,use_data_graph:0,use_pretty_print:0,used_id:0,user:0,utm:0,valid:0,valu:0,var_dim:0,var_valu:0,variabl:0,variableinstance1:0,variableinstance2:0,variableinstance3:0,variableinstance4:0,varieti:0,versatil:0,version:0,vispack_add:0,vispack_cr:0,vispack_fold:[],vispack_vers:0,visual:0,wai:0,want:0,warn:0,weight:0,well:0,when:0,where:0,whether:0,which:0,window:0,wing:0,without:0,wn2898:0,work:0,workflow:0,written:0,wrong:0,xdsm:0,xml:0,xmlschema:0,xpath:0,yet:0,yield:0,you:0,your:0,zero:0,zip:0},titles:["Welcome to KADMOS’s documentation!"],titleterms:{code:0,document:0,fundamentalproblemgraph:0,graph:0,kadmo:0,kadmosgraph:0,knowledgebas:0,mdaodatagraph:0,mdaoprocessgraph:0,repositoryconnectivitygraph:0,util:0,welcom:0,xmlutil:[]}}) \ No newline at end of file +Search.setIndex({envversion:46,filenames:["KADMOS"],objects:{"":{kadmos:[0,0,0,"-"]},"kadmos.graph":{FundamentalProblemGraph:[0,3,1,""],KadmosGraph:[0,3,1,""],MdaoDataGraph:[0,3,1,""],MdaoProcessGraph:[0,3,1,""],RepositoryConnectivityGraph:[0,3,1,""]},"kadmos.graph.FundamentalProblemGraph":{add_function_problem_roles:[0,1,1,""],cleancopy:[0,1,1,""],create_mdg:[0,1,1,""],create_mpg:[0,1,1,""],get_coupling_matrix:[0,1,1,""],get_mdg:[0,1,1,""],get_mg_function_ordering:[0,1,1,""],get_mpg:[0,1,1,""],mark_as_constraint:[0,1,1,""],mark_as_design_variable:[0,1,1,""],mark_as_objective:[0,1,1,""],mark_as_qoi:[0,1,1,""]},"kadmos.graph.KadmosGraph":{add_cycle:[0,1,1,""],add_edge:[0,1,1,""],add_edges_from:[0,1,1,""],add_node:[0,1,1,""],add_nodes_from:[0,1,1,""],add_objective_function_by_nodes:[0,1,1,""],add_path:[0,1,1,""],add_star:[0,1,1,""],add_weighted_edges_from:[0,1,1,""],adjacency_iter:[0,1,1,""],adjacency_list:[0,1,1,""],adjlist_dict_factory:[0,4,1,""],check:[0,1,1,""],check_cmdows_integrity:[0,1,1,""],check_for_coupling:[0,1,1,""],cleancopy:[0,1,1,""],clear:[0,1,1,""],copy:[0,1,1,""],copy_node_with_suffix:[0,1,1,""],count_function_nodes:[0,1,1,""],create_dsm:[0,1,1,""],degree:[0,1,1,""],degree_iter:[0,1,1,""],disconnect_problematic_variables_from:[0,1,1,""],edge_attr_dict_factory:[0,4,1,""],edges:[0,1,1,""],edges_iter:[0,1,1,""],expand_node:[0,1,1,""],find_all_nodes:[0,1,1,""],get_adjacency_matrix:[0,1,1,""],get_categorized_nodes:[0,1,1,""],get_contracted_graph:[0,1,1,""],get_direct_coupling_nodes:[0,1,1,""],get_edge_data:[0,1,1,""],get_function_graph:[0,1,1,""],get_function_metadata:[0,1,1,""],get_function_nodes:[0,1,1,""],get_graph_properties:[0,1,1,""],get_node_attributes:[0,1,1,""],get_node_subcategory:[0,1,1,""],get_nodes_based_on_strings:[0,1,1,""],get_nodes_indegree:[0,1,1,""],get_nodes_outdegree:[0,1,1,""],get_nodes_subcategory:[0,1,1,""],get_number_of_couplings:[0,1,1,""],get_partitioned_graph:[0,1,1,""],get_sources:[0,1,1,""],get_subgraph_by_function_nodes:[0,1,1,""],get_system_inputs:[0,1,1,""],get_targets:[0,1,1,""],has_edge:[0,1,1,""],has_node:[0,1,1,""],has_nodes:[0,1,1,""],has_predecessor:[0,1,1,""],has_successor:[0,1,1,""],in_degree:[0,1,1,""],in_degree_iter:[0,1,1,""],in_edges:[0,1,1,""],in_edges_iter:[0,1,1,""],inspect:[0,1,1,""],inspect_node:[0,1,1,""],inspect_nodes:[0,1,1,""],is_directed:[0,1,1,""],is_multigraph:[0,1,1,""],make_all_variables_valid:[0,1,1,""],merge_function_modes:[0,1,1,""],merge_function_nodes_based_on_modes:[0,1,1,""],merge_parallel_functions:[0,1,1,""],merge_sequential_functions:[0,1,1,""],nbunch_iter:[0,1,1,""],neighbors:[0,1,1,""],neighbors_iter:[0,1,1,""],node_dict_factory:[0,4,1,""],node_is_function:[0,1,1,""],node_is_hole:[0,1,1,""],node_is_objective_function:[0,1,1,""],node_is_output:[0,1,1,""],node_is_variable:[0,1,1,""],nodes:[0,1,1,""],nodes_iter:[0,1,1,""],nodes_with_selfloops:[0,1,1,""],number_of_edges:[0,1,1,""],number_of_nodes:[0,1,1,""],number_of_selfloops:[0,1,1,""],order:[0,1,1,""],out_degree:[0,1,1,""],out_degree_iter:[0,1,1,""],out_edges:[0,1,1,""],out_edges_iter:[0,1,1,""],plot_adjacency_matrix:[0,1,1,""],plot_graph:[0,1,1,""],predecessors:[0,1,1,""],predecessors_iter:[0,1,1,""],print_graph:[0,1,1,""],remove_edge:[0,1,1,""],remove_edges_from:[0,1,1,""],remove_function_nodes:[0,1,1,""],remove_node:[0,1,1,""],remove_nodes_from:[0,1,1,""],reverse:[0,1,1,""],save:[0,1,1,""],select_objectives_from_graph:[0,1,1,""],selfloop_edges:[0,1,1,""],size:[0,1,1,""],split_variables:[0,1,1,""],subgraph:[0,1,1,""],successors:[0,1,1,""],successors_iter:[0,1,1,""],to_directed:[0,1,1,""],to_undirected:[0,1,1,""],vispack_add:[0,1,1,""],vispack_create:[0,1,1,""]},"kadmos.graph.MdaoDataGraph":{cleancopy:[0,1,1,""],connect_converger:[0,1,1,""],connect_coordinator:[0,1,1,""],connect_doe_block:[0,1,1,""],connect_nodes_as_output:[0,1,1,""],connect_optimizer:[0,1,1,""],connect_qoi_nodes_as_input:[0,1,1,""],copy_node_as:[0,1,1,""],manipulate_coupling_nodes:[0,1,1,""]},"kadmos.graph.MdaoProcessGraph":{add_parallel_process:[0,1,1,""],add_simple_sequential_process:[0,1,1,""],cleancopy:[0,1,1,""],connect_nested_iterators:[0,1,1,""],get_nested_process_ordering:[0,1,1,""],get_node_text:[0,1,1,""],get_process_list:[0,1,1,""],inspect_process:[0,1,1,""]},"kadmos.graph.RepositoryConnectivityGraph":{cleancopy:[0,1,1,""],get_fpg_based_on_function_nodes:[0,1,1,""],get_fpg_based_on_list_functions:[0,1,1,""],get_fpg_based_on_sinks:[0,1,1,""],get_fpg_by_function_nodes:[0,1,1,""],get_function_paths_by_objective:[0,1,1,""],get_path_combinations:[0,1,1,""],select_function_combination_from:[0,1,1,""]},"kadmos.utilities":{general:[0,0,0,"-"]},"kadmos.utilities.general":{color_list:[0,2,1,""],export_as_json:[0,2,1,""],format_string_for_d3js:[0,2,1,""],get_element_dict:[0,2,1,""],get_friendly_id:[0,2,1,""],get_list_entries:[0,2,1,""],get_mdao_setup:[0,2,1,""],get_schema:[0,2,1,""],get_unique_friendly_id:[0,2,1,""],hex_to_rgb:[0,2,1,""],make_camel_case:[0,2,1,""],make_plural:[0,2,1,""],open_file:[0,2,1,""],remove_if_exists:[0,2,1,""],string_eval:[0,2,1,""],test_attr_cond:[0,2,1,""],transform_data_into_strings:[0,2,1,""],transform_string_into_format:[0,2,1,""],unmake_camel_case:[0,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","function","Python function"],"3":["py","class","Python class"],"4":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:method","2":"py:function","3":"py:class","4":"py:attribute"},terms:{"1e4":0,"5pm":0,"__iter__":0,"__len__":0,"_check_category_a":0,"_check_category_b":0,"_check_category_c":0,"_ui_d":0,"boolean":0,"case":0,"class":0,"default":0,"export":0,"final":0,"float":0,"function":0,"int":0,"long":0,"new":0,"return":0,"true":0,"while":0,abl:0,abov:0,accord:0,account:0,action:0,actual:0,add:0,add_cycl:0,add_edg:0,add_edges_from:0,add_function_problem_rol:0,add_nod:0,add_nodes_from:0,add_nodes_subcategori:[],add_objective_function_by_nod:0,add_parallel_process:0,add_path:0,add_simple_sequential_process:0,add_star:0,add_to_visualization_packag:[],add_weighted_edges_from:0,addit:0,adj_it:0,adj_list:0,adjac:0,adjacency_it:0,adjacency_list:0,adjlist_dict_factori:0,adjust:0,advanc:0,after:0,agile_ey01_demo:[],aircraft:0,algorithm:0,alia:0,all:0,all_nod:0,allow:0,allow_unconverged_coupl:0,alreadi:0,also:0,alwai:0,american:0,amount:0,analys:0,analysi:0,analyz:0,ani:0,anoth:0,appear:0,append:0,appli:0,applic:0,arbitrari:0,architectur:0,architecture_rol:0,arg:0,argument:0,around:0,ask:0,assess:0,assign:0,associ:0,assum:0,attempt:0,attr:0,attr_cond:0,attr_dict:0,attr_exclud:0,attr_includ:0,attr_list:0,attr_valu:0,attrdict:0,attribut:0,attrnam:0,automat:0,avail:0,avoid:0,back:0,base:0,baselin:0,basestr:0,becaus:0,becom:0,been:0,befor:0,begin:[],belong:0,below:0,between:0,bitbucket:0,block:0,blue:0,bool:0,both:0,bound:0,box:0,build:[],call:0,camelcas:0,can:0,capac:0,care:0,categori:0,certain:0,chang:0,characterist:0,check:0,check_cmdows_integr:0,check_for_coupl:0,child:0,choic:0,choos:0,circular:0,clariti:0,clean:0,cleancopi:0,clear:0,close:0,clutter:0,cmdow:0,collect:0,collid:0,collis:0,color:0,color_list:0,color_set:0,combin:0,common:0,compar:0,complet:0,compon:0,compress:0,comput:0,condit:0,config:0,configur:0,connect:0,connect_converg:0,connect_coordin:0,connect_doe_block:0,connect_nested_iter:0,connect_nodes_as_output:0,connect_optim:0,connect_qoi_nodes_as_input:0,consid:0,consist:0,constraint:0,constraint_nod:0,construct:0,contain:0,content:0,contig:0,continu:0,contract:0,contracted_graph:0,contraction_level:0,contrast:0,control:0,conv_typ:0,conveni:0,converg:0,convert:0,coordin:0,copi:0,copy_node_a:0,copy_node_with_suffix:0,copy_typ:0,correct:0,corrupt:0,count:0,count_function_nod:0,coupl:0,coupling_funct:0,cpac:0,creat:0,create_dsm:0,create_mdg:0,create_mpg:0,create_visualization_packag:[],creation:[],creator:0,crete:0,criteria:0,cross:0,current:0,custom:0,cut:0,cwd:0,cycl:0,d3j:0,data:0,data_dictionari:0,databas:0,datadict:0,datavalu:0,datetim:0,ddict:0,deep:0,deepcopi:0,defin:0,degre:0,degree_it:0,delet:0,delft:0,descend:0,descirb:0,descript:0,design:0,design_variable_nod:0,desir:0,destin:0,destination_fold:0,detail:0,determin:0,develop:0,diagon:0,diagram:0,diciplin:0,dict:0,dictionari:0,differ:0,digraph:0,dimens:0,direct:0,directli:0,directori:0,disciplinari:0,disconnect:0,disconnect_collided_target:0,disconnect_problematic_variables_from:0,disconnect_shared_sourc:0,disregard:0,distinguis:0,divid:0,doc:0,doe:0,doe_block:0,doesn:0,done:0,dont:0,draw:0,dsm:0,dtc:0,due:0,duplic:0,dynam:0,each:0,ebunch:0,edg:0,edge_attr_dict_factori:0,edge_dict:0,edge_ind:0,edge_it:0,edge_label:0,edge_list:0,edgelist:0,edges_it:0,edu:0,effect:0,either:0,element:0,empti:0,enabl:0,encount:0,end:0,end_in_converg:0,end_in_iterative_nod:0,end_nod:0,enrich:0,ensur:0,entri:0,entries_to_remov:0,equival:0,error:0,especi:0,etc:0,etre:0,evalu:0,even:0,everi:0,exampl:0,examplegraph:[],exce:0,except:0,exchang:0,exclud:0,exclus:0,execut:0,exhaust:0,exist:0,expand:0,expand_nod:0,expect:0,explicit:0,export_as_json:0,export_d3js_fil:[],express:0,extend:[],extend_list_uniqu:[],extens:0,extension_list:[],extract:0,fail:0,fals:0,faster:0,fastest:0,feedback:0,feedforward:0,fig_num:0,fig_siz:0,figur:0,file:0,file_nam:0,file_path:0,file_typ:0,filenam:0,filter:0,find:0,find_all_nod:0,finish:0,first:0,folder:0,follow:0,form:0,format:0,format_string_for_d3j:0,found:0,fpg:0,from:0,front:0,full:0,func_ord:0,function_ord:0,function_order_method:0,fundament:0,further:0,gauss:0,gener:0,get:0,get_adjacency_matrix:0,get_categorized_nod:0,get_contracted_graph:0,get_coupling_matrix:0,get_direct_coupling_nod:0,get_edge_data:0,get_element_dict:0,get_fpg_based_on_function_nod:0,get_fpg_based_on_list_funct:0,get_fpg_based_on_sink:0,get_fpg_by_function_nod:0,get_friendly_id:0,get_function_graph:0,get_function_metadata:0,get_function_nod:0,get_function_paths_by_object:0,get_graph_nodes_indegre:[],get_graph_nodes_outdegre:[],get_graph_properti:0,get_list_entri:0,get_mdao_setup:0,get_mdg:0,get_mg_function_ord:0,get_mpg:0,get_nested_process_ord:0,get_node_attribut:0,get_node_subcategori:0,get_node_text:0,get_nodes_based_on_str:0,get_nodes_indegre:0,get_nodes_outdegre:0,get_nodes_subcategori:0,get_number_of_coupl:0,get_partitioned_graph:0,get_path_combin:0,get_process_list:0,get_schema:0,get_sourc:0,get_subgraph_by_function_nod:0,get_system_input:0,get_target:0,get_unique_friendly_id:0,give:0,given:0,gkhome:0,glaro:0,graph_check_crit:0,graph_properti:0,graphml:0,group:0,guarante:0,guess:0,handl:0,has_edg:0,has_nod:0,has_predecessor:0,has_successor:0,hash:0,hashabl:0,have:0,hello:0,here:0,hex:0,hex_to_rgb:0,highest:0,hold:0,hole:0,how:0,howev:0,html:0,http:0,ident:0,idf:0,ignor:0,ignore_func:0,illustr:0,implement:0,in_degre:0,in_degree_it:0,in_edg:0,in_edge_it:0,in_edges_it:0,includ:0,include_al:0,include_couplings_as_final_output:0,include_reference_data:0,include_system_var:0,incom:0,indegre:0,indent:0,independ:0,index:0,indic:0,induc:0,inform:0,initi:0,inplac:0,input:0,input_list:0,inputless:0,insid:0,inspect:0,inspect_nod:0,inspect_process:0,inspir:[],integ:0,integr:0,interest:0,interfac:[],invalid:0,is_direct:0,is_multigraph:0,italian:0,item:0,iter:0,iterative_nod:0,itertool:0,itself:0,jacobi:0,japanes:0,json:0,just:0,kdm:0,keep:0,keep_empty_el:0,keep_objective_vari:0,keep_tex_fil:0,kei:0,kept:0,keyerror:0,keys_to_be_remov:0,keyword:0,kwarg:0,label:0,label_extens:0,larg:0,last:0,lead:0,least:0,len:0,length:0,less:0,let:0,level:0,librari:0,like:0,limit:0,link:0,list:0,list_of_funct:0,list_of_nod:0,list_of_sink:0,literatur:0,load:0,local:0,log:0,look:0,loop:0,lost:0,lower:0,lower_bound:0,lowest:0,main:[],mainli:0,make:0,make_all_variables_valid:0,make_camel_cas:0,make_plur:0,make_plural_opt:0,mani:0,manipul:0,manipulate_coupling_nod:0,manual:0,mark:0,mark_as_constraint:0,mark_as_design_vari:0,mark_as_object:0,mark_as_qoi:0,master:0,match:0,mathproblem:[],matplotlib:0,matrix:0,max_func:0,maximum:0,mda:0,mda_typ:0,mdao:0,mdao_setup:0,mdf:0,mdg:0,mdo:0,mdo_architectur:0,meet:0,membership:0,merg:0,merge_func:0,merge_function_mod:0,merge_function_nodes_based_on_mod:0,merge_parallel_funct:0,merge_sequential_funct:0,merger:0,metadata:0,method:0,meti:0,mg_function_ord:0,middl:0,might:0,min_func:0,mind:0,minimum:0,mode:0,modifi:0,modul:0,more:0,most:0,move:[],move_and_open:[],mpg:0,multidigraph:0,multigraph:0,multipl:0,must:0,mutabl:0,my_obj_fcn_nam:0,mygraph:0,n_part:0,name:0,named_obj_fcn:0,nativ:0,nbrdict:0,nbunch:0,nbunch_it:0,nd_iter:0,nedg:0,need:0,neighbor:0,neighbors_it:0,nest:0,nested_funct:0,networkx:0,networkxerror:0,new_label:0,niter:0,nlist:0,nloop:0,nnode:0,no_circleview_variables_data:[],node:0,node_dict_factori:0,node_id:0,node_is_funct:0,node_is_hol:0,node_is_objective_funct:0,node_is_output:0,node_is_vari:0,node_nam:0,nodelist:0,nodes_it:0,nodes_with_selfloop:0,nomin:0,nominal_valu:0,non:0,none:0,nonetyp:0,normal:0,notat:0,note:0,number:0,number_of_edg:0,number_of_nod:0,number_of_selfloop:0,numer:0,obj_vars_cov:0,object:0,objective_nod:0,obtain:0,off:0,onc:0,onli:0,only_feedback:0,open:0,open_fil:0,open_pdf:0,oper:0,optim:0,option:0,order:0,org:0,origin:0,original_list:[],other:0,otherwis:0,our:0,out:0,out_degre:0,out_degree_it:0,out_edg:0,out_edges_it:0,outdegre:0,outgo:0,output:0,outputless:0,over:0,overal:0,overrid:0,override_with_final_output:0,overview:0,own:0,packag:0,page:0,pair:0,parallel:0,parallel_funct:0,param:0,paramet:0,part:0,partit:0,pass:0,path:0,paus:0,pdf:0,perform:0,pickl:0,place:0,platform:0,plot:0,plot_adjacency_matrix:0,plot_graph:0,plural:0,point:0,posit:0,possibl:0,post:0,pre:0,preced:0,predecessor:0,predecessors_it:0,prefix:0,presenc:0,present:0,pretti:0,pretty_print:0,print:0,print_attribut:0,print_coupl:0,print_graph:0,print_in_log:0,problem:0,problemat:0,process:0,process_info:0,produc:0,product:0,progress_path:[],prompt:0,properti:0,provid:0,psg:0,pull:0,pure:0,purpos:0,pymerg:0,pyplot:0,python:0,qoi:0,qoi_nod:0,quantiti:0,queri:0,quietli:0,rais:0,raise_error:0,raise_error_if_tru:0,rang:0,rce:0,read:0,readabl:0,reciproc:0,recognis:0,recurs:0,reduc:0,reduct:0,refer:0,reference_fil:0,refin:0,reflect:0,rel:0,relev:0,remain:0,remov:0,remove_after_compress:0,remove_edg:0,remove_edges_from:0,remove_feedback:0,remove_feedforward:0,remove_function_nod:0,remove_if_exist:0,remove_nod:0,remove_nodes_from:0,replac:0,replacement_index:0,repres:0,represent:0,request:0,requir:0,resolv:0,resourc:0,respect:0,result:0,retriev:0,revers:0,rgb:0,right:0,role:0,routin:0,run:0,runtim:0,safe:0,same:0,sampl:0,sampledir:0,samplefil:0,satisfi:0,save:0,save_a:0,schema:0,script:0,search:0,second:0,see:0,seidel:0,select:0,select_function_combination_from:0,select_objectives_from_graph:0,self:0,selfloop:0,selfloop_edg:0,sellar:0,sellarproblem:[],separ:0,sequenc:0,sequenti:0,set:0,sever:0,shallow:0,share:0,should:0,show:0,show_now:0,shown:0,sidebar:0,signific:0,silent:0,similar:0,simpl:0,simpler:0,simpli:0,simplifi:0,sinc:0,singl:0,sink:0,size:0,slash:[],slave:0,small:0,some:0,sort:0,sort_bi:0,sort_kei:0,sourc:0,space:0,specif:0,specifi:0,split:0,split_all_vari:[],split_vari:0,splittabl:0,standard:0,star:0,start:0,start_nod:0,start_step:0,statement:0,step:0,still:0,store:0,str:0,strength:[],string:0,string_ev:0,structur:0,sub:0,subcategori:0,subclass:0,subdirectori:[],subfold:[],subgraph:0,subset:0,successor:0,successors_it:0,suffix:0,suit:0,sum:0,summar:0,summarize_var:0,suppli:0,sure:0,symbol:0,syntax:0,system:0,system_input:0,tabl:0,take:0,taken:0,target:0,temporari:0,test:0,test_attr_cond:0,test_valu:0,tex:0,text:0,thei:0,them:0,therefor:0,thi:0,think:0,third:0,those:0,though:0,three:0,through:0,thu:0,time:0,timestamp:0,titl:0,to_direct:0,to_undirect:0,todo:0,togeth:0,tool:0,total:0,tpwgt:0,transfer:0,transform:0,transform_data_into_str:0,transform_string_into_format:0,translat:0,tree:0,tupl:0,twice:0,two:0,type:0,uid_length:0,umn:0,unconnect:0,underscor:0,undirect:0,uniqu:0,unmake_camel_cas:0,unnamed_funct:0,unpack:0,until:0,unwant:0,updat:0,upper:0,upper_bound:0,usag:0,use_d3js_node_id:0,use_data_graph:0,use_pretty_print:0,used_id:0,user:0,utm:0,valid:0,valu:0,var_dim:0,var_valu:0,variabl:0,variableinstance1:0,variableinstance2:0,variableinstance3:0,variableinstance4:0,varieti:0,versatil:0,version:0,vispack_add:0,vispack_cr:0,vispack_fold:[],vispack_vers:0,visual:0,wai:0,want:0,warn:0,weight:0,well:0,when:0,where:0,whether:0,which:0,window:0,wing:0,without:0,wn2898:0,work:0,workflow:0,written:0,wrong:0,xdsm:0,xml:0,xmlschema:0,xpath:0,yet:0,yield:0,you:0,your:0,zero:0,zip:0},titles:["Welcome to KADMOS’s documentation!"],titleterms:{code:0,document:0,fundamentalproblemgraph:0,graph:0,kadmo:0,kadmosgraph:0,knowledgebas:0,mdaodatagraph:0,mdaoprocessgraph:0,repositoryconnectivitygraph:0,util:0,welcom:0,xmlutil:[]}}) \ No newline at end of file diff --git a/doc_source/KADMOS.rst b/doc_source/KADMOS.rst index 236d62ae5ed30dfe49afd5cc5b7e4c2fd8cef1b5..3bf46ac3e47244c907334c76b39e3165056c19fd 100644 --- a/doc_source/KADMOS.rst +++ b/doc_source/KADMOS.rst @@ -17,18 +17,16 @@ Documentation for the Code .. automodule:: kadmos -Below the main class diagram of the KADMOS package is shown. +Below the simplified class diagram of the KADMOS package is shown (not all methods are included for clarity). -.. image:: ../doc_source/images/KADMOS_UMLs.png +.. image:: ../doc_source/uml/KADMOS_UML.png :width: 70 % :align: center -Example scripts for using KADMOS are available in the scripts folder. The following scripts are available there: +Example scripts for using KADMOS are available in the examples/scripts folder. The following scripts are available there: -* ``sellarProblem.py``: Small two-disciplinary MDO problem based on MDO literature. -* ``AGILE_EY01_DEMO.py``: Small-size MDO problem inspired on CPACS data schema. -* ``mathProblem.py``: User-adjustable (in size and coupling strength) MDO problem based on MDO literature. -* ``exampleGraphs.py``: Script that combines different example scripts and provides graphs that can be used for visualization. +* ``Sellar Problem``: Small two-disciplinary MDO problem based on MDO literature. +* ``TU Delft Wing Design``: The wing design case descirbed here was developed at TU Delft and takes a variety of different diciplines into account. KnowledgeBase ************* diff --git a/doc_source/images/KADMOS_UMLs.png b/doc_source/images/KADMOS_UMLs.png deleted file mode 100644 index eafdbae1f3a7a062f9f971d6013fb288a549cb81..0000000000000000000000000000000000000000 Binary files a/doc_source/images/KADMOS_UMLs.png and /dev/null differ diff --git a/doc_source/uml/KADMOS_UML.png b/doc_source/uml/KADMOS_UML.png new file mode 100644 index 0000000000000000000000000000000000000000..a6c0ec369823b901331135c106f335484b5ed23f Binary files /dev/null and b/doc_source/uml/KADMOS_UML.png differ diff --git a/doc_source/uml/KADMOS_UML.xml b/doc_source/uml/KADMOS_UML.xml new file mode 100644 index 0000000000000000000000000000000000000000..c6c6de5d7732f74f84b1bb804fc3030784be4efb --- /dev/null +++ b/doc_source/uml/KADMOS_UML.xml @@ -0,0 +1 @@ +<mxfile userAgent="Mozilla/5.0 (Windows NT 10.0; WOW64; rv:54.0) Gecko/20100101 Firefox/54.0" version="6.9.4" editor="www.draw.io" type="device"><diagram id="ac0d2cb3-6464-fbef-b954-19e97843b8e4" name="Page-1">7V1bc6M6Ev41qdp9OC5uBvyYOM5M6uRWjs/OnidKMbKtCSAGcBKfX78SIAySwNjGE9eGVMoxUnNTf+r+1C0pF/rY//gWgXB1j13oXWiK+3GhX19ommFo5JMWbLICTVGzgmWE3KyoVPCM/oF5oZKXrpEL44pggrGXoLBaOMdBAOdJpQxEEX6vii2wV71rCJZQKHieA08s/YHcZJWXmkNtW/EdouWK3Vo1R1nNC5i/LiO8DvIbXmj6Iv3Jqn3ALpa/abwCLn4vFemTC30cYZxk3/yPMfRo27J2y867qaktHjyCQdLmhPyF3oC3zt89gMk7jl4/BtcoVW7+nMmGNU78jnwPBOToaoGD5DmvUckx8NAyIN/n5O4wIgVvMEoQadfLvCLBISmdr5Dn3oENXtNnjBPSZuzoaoUj9A+5LPDya5LqKMkhopkViWd6JilWSGkEYyLzxF5cLYruQJzkMnPseSCM0UvxwD6Ilii4wkmC/VyIvd4N8rwx9nCUvjXTon4ltnDe6PRd4UepKG/xbxD7MIk2RCSvtZj28+6hm9nh+xZrmpKLrMowM60c4zm+l8Wli7tNSX8AwZK8YXE7zarebqgIt1N1ye00s3o34BGlBiCBVxTfcRlX5EvpRbdFKdrkyNMF5F1oV6lFoKDTL2mf34TkNchT6B8gbXlaHxBjk1XHSSTUQneZ1ybrkDYCB16ioSQFVYRfIVNvgDM0lzSeFzFAe3CR1MI5DsEcBcu7VOba2JZM87akRZicu/DSrr5CrgsDClCcgARkaKTQCzEKkrSxh1fkl6hkrAyGF0Py4GNyrG6PyS8Vj5IxDsi7AJRiERKov0MKdwlKtdYo3VTVvwuVQ6MelBV8NIDBkICB05yHUo1kmmNWWT1IbT5RgAe3eppRNV7/oQq61EVd6hK9eeAFek84RgnC9PpRJsvp8zeozBZ7tlRl9vEaG9Z0X+C6Du2i//q30DdpFe2fNVUh8Y20qu+xB6vfbqd+Uzte/7otaIrqlrEB8qIrvMQB8Cbb0quUGEE3b7xV4jMnT9452vyXlg8IsvLjv4tK95KSOnL44mHq8WkR9c/5hX7CJNnkFAGsE0yVV9z/Dqe9W5XaDviBkuy2w/zo7/yatW4+xutozvFVQlGWkInltizzRA1Ki6AHEvRWpZwNnv2JYm3r1Q1rNLCHlmpo6aeuVn08c/Lsgtlj59fYqpk0LNiUxHJA19/V5riEwfFLTt4aNsqTL9kTHMoimAZKdugVuD6OBymPyD4dl3TawTX56BntaRitbgw5+I1EU2TJKG0T8NvaIltkC8fYolqbULJSgpFKlcrMVO6L0rKSnerMkEktzG5rZYjWSjvSNrVVkSoyvD/Tfpr3yIIPSHpvXlSRP58ebKif34MX1XIXQHsxF0gTqTHnNnzpqM+bnCuQsk9bNq7U9Q4AVUdAL6fj77ezyXj213TiTB/vJs/OzV8P2ZjQQ6Tdee75bXr59N25fXbGjw+z6eV4NrnOpF8w9mqkn6aPT5Pp7HbyXL5wz1w5DtSeuhpqO+wMzQ6gY0qg048291fayGqntA6Gm6pV093nHgTBHIcbyahyvoLzV0l5DN5kg1AUxCGcJ5Ia4i6dxTqY0xZ3Uqcku2roocR5AxGiyoolEmFE1FB7fuhheWVvVg5GqKoM20FUZf7kqJhIt2PiNjy0OlreSTLVo0bL7VimLbLM4WnGxPsOXkdKlbFYfHKEk1cV+8gTVEXZcYZmNp9x/AjZFiznvQtwaTTcxL3TkTMnf0bcW/mi3NviUFMc7+TeChcXOsTOFc8rOGPih9PorwNk/i9P1zq/MEqlYiLmoCBcy3wuEy4ECR6aJecYRy4KQIKjRqmAtPMSNsngMEE+wUqTjIuhkxpYiYwPAhSuiSmD5HZrwguCZfYenGzv5CV9wW7dGdjYoSX2VbML7GsC9qcwpGwcR5txhg30lmza2lbJyag4+4ws7VeNcui7Da0uTZ7row7AVpckf7qcfX927m7vb2dZACIlFZwV+nE5fbh9+NYk1lsdpq69k22SiIUUCJ3goM+Pd6M0SYhSqrQOIha1GfIYepQ/FPGEOfZfKGuh3xcR9nfFH2iePHZeNg5++Zn6C1ksg55BBctXl1Gy9Mrhkl6uuIGMqVRkQQxdhwjGKHhtJUjDo8X1W50hPswXNVWCV+6kG4gTBaTdQFW1DjqCGG69WQcu8CF9q6cIk3bz29Kl2jN7qvTpVMngwysyrqTJuJLRBTGvixA/Ps1uHx/SLNCYfnMep9eTqXM/mX1/vO7TNzKDYrZWfQMZkmq6g/SNJga0ejJ0iNJMMX0jVVoXZGhU0zmJbXulwR3i5ElzF9kTaUwlk2xiPfvI/MKoZiLilmllHsaJsDyfQ1lLEd/xQRKhjxopf7m9Ko5cGJEzZLGlCNKYkR82VbrLL0yHusC9JeaEpLhXzQ5yQroYLxKUJ0nZlPJAklmLlUlD2zyRJiSK9sw+lRJLljDDqZYh7Mr+sDl6O7M/JYUMJfpgZUdOnLRss0pTFG6EXjNVUrjQkFtXYfGx9awRjp5zafMxqB1ZqKFhNckfnVHSZVGpE0G6depTPQDurRDNXu6MEW0rHKJ1DohtEW1yDN60Od/fEaKL4EhLRBt6o/zxiG4RXzudkW6YVdoOoeb5I1TlEMqP+FojVOUQOmqH0ANAMdRFDJx4NofodE+49qEVtlj0+jescNjXiKgGv65xx1oEe3TatQi6OMiRhLHIoGIO43jwlP09u/DV/8mKBFXjV6q0X5LQQZDCEDnSdA5bRDkZPLbS5wONLzvdRuWXPVmmZL6yIQt48VTsIDDJ6AkNCUzHbIr7+HL23DDHnQr+uHFubu8mD5f3k/r106ng4/RPmje+vp2WBPuAQ8J17aMmqMjAMuwg3mDI0o59dHR/pY0kM4dlSusgOmrIFiSwaKSLQMrlnDBvFVkkkgquP9KE7xq5dbHKNxA5AfBlUdE8uEh4n/O+kNS/R6iodghMpPHQTIhOw3M+fG+HGKklTsr5GdNsL5PsjczBeFUVvR1gVa1hF5G2kGX+79Omup/D4IjF2cqDIzYI+OzBka7sF2JRdfu0UUNDzM/SeeXVYVAbZiye1TPkz2fIqrabIctTwkoXwy1ZTlhYDcqT5N7bMG9jtdZ3PaU9WcLfkCWPe0q7v9JMcUenUyX8WdxY6JD5IktmzWu4bIz80INODH+tyfsiyn4b5Um7AM+DTWLFehLSntB1CAWN6EqROq6crmKhFqFucmV2o3RqY90lsjsxyZq8f2+EDsazZbTDs8qS8EchWgzCVEiKjz5Q4PiEnKQM5Z4etqUm+m+gJucQ110I5dpcSk1c88Ucmh1RE43LaqpK24DMqIPg3bBuXmIEfdLnMkND530XI3350nTyvpksGS+XJXv7waJne68Ol+1wKI3LdbDDIZts92nZRG5teK7/rsbLle2P2GC8vP9R60G1mYcxzjHjqHLbXLHF220zjpz80WNqU8wySXzSG6Ld9XXwn+xv75nOxjMpnGcq2EvZIo2kMbwOtlAy68LOOWAcwqwlvojVZiHjisAfpNopzo6pzxIC1hUZH7zC3omVMGTuHfeVOTEZZOwOnJh1oqivZE7UyTYxqZtu1XpCIBunCNvviTueHOugZB5oNDC3P1zI1lLKlfxu4W3nWKkGt7uErXAP2tE0QIGZ7wxSq8eeMLJ3hcG1xhOOdtlszNr5vrm/de7YkfvmGhKOd6LEiahh0xgO9NIPlycx1U76kKU3dFTTNga2+Ahddy9+Ou/O3mLYetMJx4NfnJwg4aukgen0p56nngtPHQl7VMkCKNKdxjsIoFh1uR0aY6UzEoo983oWmXD9rPN/9tBFPofNpeuaRVptZ9af6zZ5TG2ndoHCgiKLu0RrL6eZVe9pq6dhiiN+qdWOqd6qwm+Qdtxcb3K4/Z9Mmfj2H1/pk/8B</diagram></mxfile> \ No newline at end of file