Bioscape Web Resources
From irefindex
Revision as of 12:04, 16 October 2009 by PaulBoddie (talk | contribs) (A description of the bsweb package organisation.)
The Bioscape Web resources provide the principal end-user interface to Bioscape as described in the "Using the Bioscape Web Application" document. Typically, a user will follow a specific workflow supported by a number of resources described in the application's "site map", found in the bsweb package (specifically in the __init__.py source file) in the bsweb distribution. The following table summarises the source code organisation:
Pages | Logic package/module | Database access package/module |
---|---|---|
home (search), index (advanced search) | bsweb.pages | bsweb.pages.collections |
gene disambiguation, gene summary | bsweb.genes | bsweb.genes.collections |
gene and evidence mention summaries | bsweb.documents | bsweb.documents.viewers |
document lists | bsweb.documents | bsweb.documents.collections |
annotated documents | bsweb.documents | bsweb.documents.viewers |
mention scoring summaries | bsweb.documents | bsweb.documents.collections |
To summarise, page functionality typically resides in the top-level of a package, database queries providing lists of results reside in collections modules, and the special database/text index combination supporting annotated documents resides in the viewers module in the bsweb.documents package.