NTG
Introduction
Basic Terms and Procedures of the Coherence-Based Genealogical Method (CBGM)
Links
Installation
Installation on Linux
Install Prerequisites
Database Access
Application server
CBGM
Run Server
Build and run client
Installation with Docker
Install
Running the web application
Running the CBGM
Troubleshooting
User Manual
Client
Server
server/__main__.py
Scripts
scripts/cceh/import.py
scripts/cceh/prepare.py
scripts/cceh/cbgm.py
scripts/cceh/save_edits.py
scripts/cceh/load_edits.py
scripts/cceh/mk_users.py
Developer Manual
Web Client
Modules
API Server
server
server.main
server.textflow
server.comparison
server.set_cover
server.editor
server.login
server.helpers
API Server Configuration Files
Per-Application Configuration Files
Global Configuration File
Footnotes
Scripts
scripts.cceh.import
scripts.cceh.prepare
scripts.cceh.cbgm
scripts.cceh.save_edits
scripts.cceh.load_edits
scripts.cceh.mk_users
Database Structure
CBGM Database
Source Databases
Literature
Database FAQ
Manual Editing of Journalled Tables
Apparatus Updates
Common Functions
ntg_common.cbgm_common
ntg_common.config
ntg_common.db_tools
ntg_common.exceptions
ntg_common.tools
ntg.uni-muenster.de
Apache
API Server
Postgres
Users
Backups
Icinga
OpenStack Cloud
CBGM
Preparing the Database for the CBGM
Applying the CBGM
Starting a New Project
Starting a New Phase
Starting a New Phase With Apparatus Update
User Management
Manual User Management
Technologies Used
Server
Client
Scripts
NTG
»
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
Symbols
--config-file <config_file>
server/__main__.py command line option
--email <email>
scripts/cceh/mk_users.py command line option
--help
scripts/cceh/cbgm.py command line option
scripts/cceh/import.py command line option
scripts/cceh/load_edits.py command line option
scripts/cceh/mk_users.py command line option
scripts/cceh/prepare.py command line option
scripts/cceh/save_edits.py command line option
server/__main__.py command line option
--input <path/to/input.xml>
scripts/cceh/load_edits.py command line option
--output <path/to/output.xml>
scripts/cceh/save_edits.py command line option
--password <password>
scripts/cceh/mk_users.py command line option
--range <range>
scripts/cceh/prepare.py command line option
--username <username>
scripts/cceh/mk_users.py command line option
--verbose
scripts/cceh/cbgm.py command line option
scripts/cceh/import.py command line option
scripts/cceh/load_edits.py command line option
scripts/cceh/mk_users.py command line option
scripts/cceh/prepare.py command line option
scripts/cceh/save_edits.py command line option
server/__main__.py command line option
-c <config_file>
server/__main__.py command line option
-e <email>
scripts/cceh/mk_users.py command line option
-h
scripts/cceh/cbgm.py command line option
scripts/cceh/import.py command line option
scripts/cceh/load_edits.py command line option
scripts/cceh/mk_users.py command line option
scripts/cceh/prepare.py command line option
scripts/cceh/save_edits.py command line option
server/__main__.py command line option
-i <path/to/input.xml>
scripts/cceh/load_edits.py command line option
-o <path/to/output.xml>
scripts/cceh/save_edits.py command line option
-p <password>
scripts/cceh/mk_users.py command line option
-r <range>
scripts/cceh/prepare.py command line option
-u <username>
scripts/cceh/mk_users.py command line option
-v
scripts/cceh/cbgm.py command line option
scripts/cceh/import.py command line option
scripts/cceh/load_edits.py command line option
scripts/cceh/mk_users.py command line option
scripts/cceh/prepare.py command line option
scripts/cceh/save_edits.py command line option
server/__main__.py command line option
A
Acts01GVZ (class in ntg_common.src_db)
Acts01GVZlac (class in ntg_common.src_db)
affinity (Affinity attribute)
Affinity (class in ntg_common.db)
AFTER_LOGIN_URL
ancestor_matrix (CBGM_Params attribute)
and_matrix (CBGM_Params attribute)
AnonymousUserMixin (class in server.login)
Apparatus (class in ntg_common.db)
Apparatus.ATT (in module ntg_common.db)
Apparatus.BYZ (in module ntg_common.db)
Apparatus.DEF (in module ntg_common.db)
Apparatus.f (in module ntg_common.db)
Apparatus.LAC (in module ntg_common.db)
Apparatus.LOC (in module ntg_common.db)
Apparatus.o (in module ntg_common.db)
Apparatus.ZW (in module ntg_common.db)
apparatus_json() (in module server.main)
append_marker() (built-in function)
APPLICATION_DESCRIPTION
APPLICATION_HOST
application_json() (in module server.main)
APPLICATION_NAME
APPLICATION_PORT
APPLICATION_ROOT
,
[1]
args (in module ntg_common.config)
Att (class in ntg_common.db)
Att.A (in module ntg_common.db)
Att.a (in module ntg_common.db)
Att.b (in module ntg_common.db)
Att.C (in module ntg_common.db)
Att.C1 (in module ntg_common.db)
Att.C2 (in module ntg_common.db)
Att.f (in module ntg_common.db)
Att.K (in module ntg_common.db)
Att.o (in module ntg_common.db)
Att.r (in module ntg_common.db)
Att.V (in module ntg_common.db)
Att.x (in module ntg_common.db)
attestation_json() (in module server.main)
attesting_csv() (in module server.main)
auth() (in module server.login)
B
Bag (class in server.helpers)
base (Att attribute)
bfs() (built-in function)
bk_id (Books attribute)
BOOK
book (Books attribute)
Books (class in ntg_common.db)
BOOKS (in module ntg_common.tools)
build_A_text() (in module scripts.cceh.cbgm)
build_contextmenu() (built-in function)
,
[1]
build_explain_matrix() (in module server.set_cover)
build_MT_text() (in module scripts.cceh.prepare)
BYZ_HSNR (in module ntg_common.tools)
C
calculate_mss_similarity_postco() (in module ntg_common.cbgm_common)
calculate_mss_similarity_preco() (in module ntg_common.cbgm_common)
cbgm (Apparatus attribute)
CBGM_Params (class in ntg_common.cbgm_common)
certainty (Apparatus attribute)
client
module
client/app (module)
client/apparatus (module)
client/checks_list (module)
client/coherence (module)
client/comparison (module)
client/comparison_details_table (module)
client/comparison_table (module)
client/d3_chord_layout (module)
client/d3_common (module)
client/d3_stemma_layout (module)
client/find_relatives (module)
client/flash_messages (module)
client/leitzeile (module)
client/local_stemma (module)
client/notes (module)
client/notes_list (module)
client/optimal_substemma (module)
client/optimal_substemma_details (module)
client/page_header (module)
client/project_list (module)
client/relatives_metrics (module)
client/relatives_table (module)
client/set_cover (module)
client/table_sort_mixin (module)
client/table_toggle_mixin (module)
client/textflow (module)
client/tools (module)
client/widgets/autocomplete (module)
client/widgets/button_group (module)
client/widgets/card (module)
client/widgets/card_caption (module)
client/widgets/connectivity (module)
client/widgets/context_menu (module)
client/widgets/dropdown_mixin (module)
client/widgets/labezator (module)
client/widgets/navigator (module)
client/widgets/range (module)
client/widgets/toolbar (module)
clique (Cliques attribute)
Cliques (class in ntg_common.db)
cliques_json() (in module server.main)
cliques_palette (global variable or constant)
Cliques_TTS (class in ntg_common.db)
color_string_to_palette() (built-in function)
Combination (class in server.set_cover)
common (Affinity attribute)
comp (Att attribute)
comparison_detail() (in module server.comparison)
comparison_detail_csv() (in module server.comparison)
comparison_summary() (in module server.comparison)
comparison_summary_csv() (in module server.comparison)
concat_tables_fdw() (in module scripts.cceh.import)
config_from_pyfile() (in module ntg_common.config)
copy_genealogical() (in module scripts.cceh.prepare)
copy_nestle() (in module scripts.cceh.prepare)
copy_table() (in module scripts.cceh.prepare)
copy_table_fdw() (in module scripts.cceh.import)
CORS_ALLOW_ORIGIN
count_by_range() (in module ntg_common.cbgm_common)
create_labez_matrix() (in module ntg_common.cbgm_common)
CreateFDW (class in ntg_common.db)
CreateFunction (class in ntg_common.db)
CreateGeneric (class in ntg_common.db)
CreateView (class in ntg_common.db)
csvify() (in module server.helpers)
D
declare_user_model_on() (in module server.login)
def_matrix (CBGM_Params attribute)
delete_corrector_hands() (in module scripts.cceh.prepare)
delete_invariant_passages() (in module scripts.cceh.prepare)
delete_lectionaries() (in module scripts.cceh.prepare)
deparam() (built-in function)
dir() (built-in function)
,
[1]
dot() (built-in function)
dot2css (global variable or constant)
drag_listener() (built-in function)
dragged_node (None attribute)
DropFDW (class in ntg_common.db)
DropFunction (class in ntg_common.db)
DropGeneric (class in ntg_common.db)
DropView (class in ntg_common.db)
E
edit_auth() (in module server.login)
EditError
EditException
eq_matrix (CBGM_Params attribute)
equal (Affinity attribute)
EXCLUDE_REGEX_MAP (in module server.helpers)
explained() (Combination method)
F
fehler (Att attribute)
fehlvers (Passages attribute)
FEHLVERSE (in module ntg_common.tools)
fill_apparatus_table() (in module scripts.cceh.prepare)
fill_manuscripts_table() (in module scripts.cceh.prepare)
fill_ms_cliques_table() (in module scripts.cceh.prepare)
fill_passages_table() (in module scripts.cceh.prepare)
fill_readings_table() (in module scripts.cceh.prepare)
find_relatives() (built-in function)
fix() (in module ntg_common.db_tools)
format() (built-in function)
(Formatter method)
Formatter (class in ntg_common.config)
G
generate_css_palette() (built-in function)
get_ancestors() (in module server.set_cover)
get_connection_params() (PostgreSQLEngine method)
get_excluded_ms_ids() (in module server.helpers)
goto_attestation() (built-in function)
goto_manuscript() (built-in function)
graphviz_layout() (in module ntg_common.tools)
H
highlight() (built-in function)
hs (Att attribute)
(Manuscripts attribute)
hsnr (Att attribute)
(Manuscripts attribute)
I
id (LocStemEdAct01 attribute)
import_att_fdw() (in module scripts.cceh.import)
Import_Cliques (class in ntg_common.db)
import_genealogical_fdw() (in module scripts.cceh.import)
Import_LocStem (class in ntg_common.db)
Import_MsCliques (class in ntg_common.db)
import_nestle_fdw() (in module scripts.cceh.import)
Import_Notes (class in ntg_common.db)
inflate_bbox() (built-in function)
init() (in module server.set_cover)
init_app() (in module server.comparison)
(in module server.editor)
(in module server.login)
(in module server.main)
(in module server.set_cover)
(in module server.textflow)
init_default_cliques() (in module ntg_common.db_tools)
init_default_locstem() (in module ntg_common.db_tools)
init_default_ms_cliques() (in module ntg_common.db_tools)
init_logging() (in module ntg_common.config)
insert_css_palette() (built-in function)
K
key_by() (built-in function)
L
labez (Att attribute)
(Readings attribute)
labez_matrix (CBGM_Params attribute)
labez_palette (global variable or constant)
labezsuf (Apparatus attribute)
(Att attribute)
Lac (class in ntg_common.db)
leitzeile_json() (in module server.main)
lekt (Att attribute)
lemma (Nestle attribute)
length (Ms_Ranges attribute)
lesart (Apparatus attribute)
(Readings attribute)
load_dot() (built-in function)
,
[1]
load_passage() (built-in function)
,
[1]
,
[2]
,
[3]
,
[4]
,
[5]
local_stemma_to_nx() (in module ntg_common.db_tools)
LocStem (class in ntg_common.db)
LocStem_TTS (class in ntg_common.db)
LocStemEdAct01 (class in ntg_common.src_db)
log() (in module ntg_common.tools)
M
MAIL_DEFAULT_SENDER
MAIL_PORT
MAIL_SERVER
MAIL_USE_TLS
make_safe_url() (in module server.login)
Manuscript (class in server.helpers)
manuscript_full_json() (in module server.main)
manuscript_json() (in module server.main)
Manuscripts (class in ntg_common.db)
mark_invariant_passages() (in module scripts.cceh.prepare)
mkmsg() (built-in function)
module
client
ntg_common
ntg_common.cbgm_common
ntg_common.config
ntg_common.db
ntg_common.db_tools
ntg_common.exceptions
ntg_common.tools
scripts
scripts.cceh.cbgm
scripts.cceh.import
scripts.cceh.load_edits
scripts.cceh.mk_users
scripts.cceh.prepare
scripts.cceh.save_edits
server
server.comparison
server.editor
server.helpers
server.login
server.main
server.set_cover
server.textflow
ms_id (Manuscripts attribute)
Ms_Ranges (class in ntg_common.db)
MsCliques (class in ntg_common.db)
MsCliques_TTS (class in ntg_common.db)
MYSQL_ATT_TABLES
MYSQL_CONF
MYSQL_ECM_DB
MYSQL_GROUP
MYSQL_LAC_TABLES
MYSQL_LOCSTEM_TABLES
MYSQL_MEMO_TABLE
MYSQL_NESTLE_DB
MYSQL_NESTLE_TABLE
MYSQL_RDG_TABLES
MYSQL_VAR_TABLES
MYSQL_VG_DB
MySQLEngine (class in ntg_common.db_tools)
N
n_mss (CBGM_Params attribute)
n_passages (CBGM_Params attribute)
n_ranges (CBGM_Params attribute)
natural_sort() (built-in function)
Nestle (class in ntg_common.db)
Nestle29 (class in ntg_common.src_db)
newer (Affinity attribute)
Notes (class in ntg_common.db)
notes_json() (in module server.editor)
Notes_TTS (class in ntg_common.db)
notes_txt() (in module server.editor)
ntg_common
module
ntg_common.cbgm_common
module
ntg_common.config
module
ntg_common.db
module
ntg_common.db_tools
module
ntg_common.exceptions
module
ntg_common.tools
module
nx_to_dot() (in module server.helpers)
nx_to_dot_subgraphs() (in module server.helpers)
O
older (Affinity attribute)
on_coherence_in_attestations_variant_changed() (built-in function)
on_epoch() (built-in function)
on_goto_attestation() (built-in function)
on_hashchange() (built-in function)
on_nav() (built-in function)
on_save() (built-in function)
on_sort() (built-in function)
optimal_substemma_csv() (in module server.set_cover)
optimal_substemma_detail_csv() (in module server.set_cover)
optimal_substemma_json() (in module server.set_cover)
origin (Apparatus attribute)
P
param() (built-in function)
parent_matrix (CBGM_Params attribute)
parse_bbox() (built-in function)
parse_path() (built-in function)
parse_path_svg() (built-in function)
parse_pt() (built-in function)
pass_id (Passages attribute)
passage (Books attribute)
Passage (class in server.helpers)
passage (Passages attribute)
(Ranges attribute)
passage_json() (in module server.main)
Passages (class in ntg_common.db)
path/to/_global.conf
scripts/cceh/mk_users.py command line option
path/to/file.conf
scripts/cceh/cbgm.py command line option
scripts/cceh/import.py command line option
scripts/cceh/load_edits.py command line option
scripts/cceh/prepare.py command line option
scripts/cceh/save_edits.py command line option
PGDATABASE
,
[1]
PGHOST
,
[1]
PGPORT
,
[1]
PGUSER
,
[1]
PostgreSQLEngine (class in ntg_common.db_tools)
powerset() (in module server.set_cover)
private_auth() (in module server.login)
PrivilegeError
process_commentaries() (in module scripts.cceh.prepare)
process_sigla() (in module scripts.cceh.prepare)
R
range (Ranges attribute)
range_id() (Passage method)
ranges (CBGM_Params attribute)
Ranges (class in ntg_common.db)
ranges_json() (in module server.main)
RdgAct01 (class in ntg_common.src_db)
READ_ACCESS
READ_ACCESS_PRIVATE
Readings (class in ntg_common.db)
Readings.NULL (in module ntg_common.db)
Readings.om (in module ntg_common.db)
Readings.zu (in module ntg_common.db)
Readings.zv (in module ntg_common.db)
Readings.zw (in module ntg_common.db)
Readings.zz (in module ntg_common.db)
readings_json() (in module server.main)
receive_checkout() (PostgreSQLEngine static method)
relatives_csv() (in module server.main)
remove_z_leaves() (in module server.textflow)
return_to_base() (built-in function)
Role (class in ntg_common.db)
Roles_Users (class in ntg_common.db)
row_conversion() (built-in function)
,
[1]
,
[2]
,
[3]
S
s1 (LocStemEdAct01 attribute)
s2 (LocStemEdAct01 attribute)
score() (Combination method)
scripts
module
scripts.cceh.cbgm
module
scripts.cceh.import
module
scripts.cceh.load_edits
module
scripts.cceh.mk_users
module
scripts.cceh.prepare
module
scripts.cceh.save_edits
module
scripts/cceh/cbgm.py command line option
--help
--verbose
-h
-v
path/to/file.conf
scripts/cceh/import.py command line option
--help
--verbose
-h
-v
path/to/file.conf
scripts/cceh/load_edits.py command line option
--help
--input <path/to/input.xml>
--verbose
-h
-i <path/to/input.xml>
-v
path/to/file.conf
scripts/cceh/mk_users.py command line option
--email <email>
--help
--password <password>
--username <username>
--verbose
-e <email>
-h
-p <password>
-u <username>
-v
path/to/_global.conf
scripts/cceh/prepare.py command line option
--help
--range <range>
--verbose
-h
-r <range>
-v
path/to/file.conf
scripts/cceh/save_edits.py command line option
--help
--output <path/to/output.xml>
--verbose
-h
-o <path/to/output.xml>
-v
path/to/file.conf
SECRET_KEY
server
module
server.comparison
module
server.editor
module
server.helpers
module
server.login
module
server.main
module
server.set_cover
module
server.textflow
module
server/__main__.py command line option
--config-file <config_file>
--help
--verbose
-c <config_file>
-h
-v
set_cover_json() (in module server.set_cover)
set_passage() (built-in function)
siglum (Books attribute)
sort() (built-in function)
spanned (Passages attribute)
spanning (Passages attribute)
stemma() (in module server.textflow)
stemma_dot() (in module server.textflow)
stemma_edit() (in module server.editor)
stemma_png() (in module server.textflow)
submit() (built-in function)
suffix (Att attribute)
suggest_json() (in module server.main)
sys_period (Cliques attribute)
(LocStem attribute)
(MsCliques attribute)
T
tabulate() (in module ntg_common.db_tools)
target_node (None attribute)
textflow() (in module server.textflow)
textflow_dot() (in module server.textflow)
textflow_png() (in module server.textflow)
to_csv() (Combination method)
to_json() (Combination method)
toggle_details_table() (built-in function)
U
unclear (Affinity attribute)
unclear_ancestor_matrix (CBGM_Params attribute)
unclear_parent_matrix (CBGM_Params attribute)
unroll_zw() (in module scripts.cceh.prepare)
USE_DEBUGGER
USE_RELOADER
User (class in ntg_common.db)
user_can_read() (in module server.login)
user_can_read_private() (in module server.login)
user_can_write() (in module server.login)
user_id_start (Cliques attribute)
(LocStem attribute)
(MsCliques attribute)
user_id_stop (Cliques attribute)
(LocStem attribute)
(MsCliques attribute)
USER_PASSWORD_HASH
USER_PASSWORD_SALT
V
vacuum() (PostgreSQLEngine method)
VarGenAttAct01 (class in ntg_common.src_db)
variant (Passages attribute)
variant_matrix (CBGM_Params attribute)
varid (LocStemEdAct01 attribute)
varnew (LocStemEdAct01 attribute)
Vue#$trigger() (built-in function)
Vue#build_full_api_url() (built-in function)
Vue#get() (built-in function)
W
w (LocStemEdAct01 attribute)
wait_for_server() (PostgreSQLEngine method)
Word (class in server.helpers)
WRITE_ACCESS
write_affinity_table() (in module ntg_common.cbgm_common)