tools.doi module

Tool to show the academic references for the calculation methods implemented in the code.

tools/doi

Double clik over a element open the link with the paper, or if the file is available in local system open the document. By default search the file with the doi code name or the title if doi is unavailable in the folder doc of main program.

Here is the complete list of references.

API reference

  • ShowReference: Dialog to show the references used in the program

Miscellaneous utilities

  • QLineEditClickable: Custom QLineEdit to catch Enter key and set focus to list and avoid close dialog

  • QTreeWidgetClickable: Custom QTreeWidget to catch Enter key and open file with it

  • findFile(): Search reference paper path in documentation forder and return boolean if it’s available

class tools.doi.QLineEditClickable[source]

Bases: QLineEdit

Custom QLineEdit to catch Enter key and set focus to list and avoid close dialog

Methods

keyPressEvent(event)

Rewrite keyPressEvent to setFocus when Enter key is pressed
keyPressEvent(event)[source]

Rewrite keyPressEvent to setFocus when Enter key is pressed

class tools.doi.QTreeWidgetClickable[source]

Bases: QTreeWidget

Custom QTreeWidget to catch Enter key and open file with it

Methods

keyPressEvent(event)

Rewrite keyPressEvent to expand or open item
keyPressEvent(event)[source]

Rewrite keyPressEvent to expand or open item

class tools.doi.ShowReference(parent=None)[source]

Bases: QDialog

Dialog to show the references used in the program

Methods

disableSearch()

Hide search widgets

enableSearch()

Show search widgets

fill()

Fill tree with documentation entries

open(item)

Open file if exist in doc/doi folder or open a browser with link

search(txt)

Search txt in tree widget contents

searchNext()

Set next result in search

searchPrevious()

Set previous result in search
searchIndex = -1
searchResults = []
__init__(parent=None)[source]
enableSearch()[source]

Show search widgets

disableSearch()[source]

Hide search widgets

search(txt)[source]

Search txt in tree widget contents

searchPrevious()[source]

Set previous result in search

searchNext()[source]

Set next result in search

fill()[source]

Fill tree with documentation entries

open(item)[source]

Open file if exist in doc/doi folder or open a browser with link

tools.doi.findFile(ref)[source]

Search reference paper path in documentation forder and return boolean if it’s available