Difference between revisions of "Team:HFUT-China/Documents"

Latest revision as of 01:24, 19 September 2015

HFUT-China | Documents

Unit Test

Method Name: createFolder
Function: create a new folder
Input: contentType - that need to save in the folder
Output: basePath-new folder path
Test Use Case:

Use Case ID	Test Target	ContentType	Expectation Result	Finial Result	Accept
1	get correct path when contentType is none	None	/../downloads/2015/8/6/	TypeError: cannot concatenate 'str' and 'NoneType' objects	YES
2	get correct path when contentType is ""	""	/../downloads/2015/8/6/	/../downloads/2015/8/6//	YES
3	if directory was exist and contentType are correct , new folder wouldn't cover the old directory.	'image'	don't cover	don't cover	YES
4	it's successful to create new directory at first time when the contentType is correct	'image'	create successfully	create successfully	YES

For more information about unit test result, please download documents from HERE

Releases

2015.5.30: First prototype

Account module finished. Basic design with basic part recommendation finished

2015.7.1: Second prototype

Recommendation improved, UI updated

2015.7.20: Third Prototype

System recommendation added. Performance improvements

2015.8.20: Alpha version

Simulation added, system recommendation improved, performance improved

2015.8.30: Beta version

Simulator improved. Register opened

2015.9.15 Version 1.0

Function all completed

API

design.recommend module¶

implement recommend for parts

@author: Bowen, Ray, Yu

design.recommend.getApriorRecommend(chainStr, funcStr=None)[source]¶

get recommendations with aprior algorithm

@param chainStr: part chain @type chainStr: str @return : recommendations @rytpe: dict

design.recommend.getMarkovRecommend(part_id)[source]¶

get recommendations with Markov algorithm

@param part_id: part id @type part_id: str @return : recommendations @rytpe: dict

design.recommend.getPartNameAndType(part_id)[source]¶

design.recommend.getResult(currentList, dataList)[source]¶

design.recommend.get_chain(elem, num, process)[source]¶

get chain which had predicted

according to information in process, get the chain from first element to elem variable and save the chain in a list

args:: elem: the last element in chain num: the line number in process process: a variable record the predict process
return:: a chain from first to elem variable

design.recommend.predict(m, count, s, A)[source]¶

predict the chain after s

calculate the probability of a m-length chain, then return chains. CAUTION the number of chains maybe less then count

args:: m: the length of predict chain count: the number of predict chain s: the last element of the current chain A: transition matrix
return:: some chains save in list

For more api documents, download from Here

Public API

Host: biodesigner.info/

Search

Search a part with keywords

GET

/home/search?keyword={your keyword}

Search a part with keywords and functions

GET

/home/search?keyword={your keyword}&func={function id}

Get a part's information

GET

/home/get?partname={part name}

Get functions

GET

/home/getTrackFunctions?track_id={track id}

Get tracks

GET

/home/tracks

Simulator

Do simulation

POST

/home/simulate

Simulator post data format


                    {

                        'reactions' : [ // reactions 

                            {

                                'reactants' : [{reactants in a list}],

                                'products' : [{resultants in a list}],

                                'k' : {reaction rate}

                            },

                        ],

                        'martials':[ // init compounds 

                            [{compound name}, {amount}],

                        ],

                        'reaction_time': {reaction time for simulator}

                    }

Recommend

Get part sequence recommendations

GET

/home/seqRecommend?part={part id}

Get related part recommendations (Aprior)

/home/arecommmend?seq={part id seperate with '_'}

@@ Line 80: / Line 80: @@
                  </li>
                  <li class="gh-tab"><a href="https://2015.igem.org/Team:HFUT-China/Software" class="gh-tab-link">Software</a></li>
+                <li class="gh-tab"><a href="https://2015.igem.org/Team:HFUT-China/Notebook" class="gh-tab-link">Notebook</a></li>
                  <li class="gh-tab"><a href="https://2015.igem.org/Team:HFUT-China/Design" class="gh-tab-link">Design</a></li>
                  <li class="gh-tab"><a href="https://2015.igem.org/Team:HFUT-China/Description" class="gh-tab-link">Description</a></li>