Principe de nommage des variables

Afin de savoir le type de la variable, nous préconisons la règle suivante:

x,v	x et v sont utilisés avec des variables de type float
i, imax, i1	i pour nombres entiers indiquant des indiques
n, nmax, nLmol	n pour nombres entiers associés à des quantités
r, r1, r2	r pour les caractères, c étant choisi pour les couples d’entiers.
s, s1, s2	s pour strings (chaînes de caractères)
c, c1	c pour couple d’entier ou tuple de longueur 2
p, p1, p2, …	p pour vecteur numpy de dimension 1 indiquant la position d’un élément dans un espace de dimension n.
df, dfi, df1	df pour dataframe
mol	mol pour molécule rdkit
L, Li, Ln, Lmol, Ls, Lp, Lc, LL, LLLi…	L pour liste. LLLi est une liste de liste de liste d’entiers. Ls est une liste string. Lp est une liste de points.
T, Ti, TT, …	T pour untuple (liste de valeurs de longueur fligée)
Gx, Gx1, …	Gx pour objet graphe avec Networkx
Gn, Gn1, …	Gn pour objet graphe avec Neo4J
V, Vfp	V pour vecteur numpy de dimension 1 comme les Vfp, vecteur de fingerprint.
Mn	Mn pour une matrice quelconque de type numpy.
Mp	Mp pour matrice de points
Mc	Mc pour une matrice de couple d’entiers Mcv si une valeur entière est ajoutée à droite
D, D1, Dc_Lmol, Dshash_Lmol	D pour dictionnaire. Dc_Lmol indique un dictionnaire dont la clé est un couple d’entier et la valeur un liste de molécules rdkit. Dshash_Lmol correspond à un dictionnaire ayant un shash_atom en clé et une liste de molécules en valeurs.
S, Si, Smol, ST, ..	S pour set (ensemble non ordonné sans répétition)
with_rdkit, with_Mp	with_* pour définir un booléen indique l’utilisation ou non d’une méthode ou d’un élément pour réaliser un traitement.

Principe de nommage des fonctions

bw	bw est utilisé dans les fonctions indiquant une comparaison entre 2 objets. ex: get_Mcv_bw_Mp , fonction cherchant les couples de points contenus dans 2 Mp, séparés d’une distance entre dmin et dmax.
from	from est utilisé dans les fonctions indiquant une comparaison au sein d’un même objet. ex: get_Mcv_from_Mp , fonction cherchant les couples de points contenus dans Mp, séparés d’une distance entre dmin et dmax.
select	select est utilisé avec les fonctions faisant un travail de sélection commencent par select. ex: select_Lmol_by_prop
get	get est utilisé avec les fonction générant quelque chose de nouveau en sortie. ex: get_LLmol_same_from_Lmol, fonction générant une liste de liste regroupant les molécules identiques ensemble. ex: get_Lprop_from_mol, fonction renvoyant les propriétés associées à une molécule rdkit
load	load est utilisé pour définir des fonctions liées à la lecture de fichiers. ex: load_Lmol_from_sdf
show	show est utilisé avec les fonctions permettant d’afficher des objets: ex: show_Lmol pour affichcer une liste de molécules ex: show_Gx pour afficher un graphe networkx
with	with est utilisé pour préciser un nom de fonction ou de variable (alors bouléen) lié à un outil ou une méthode ex: with_rdkit = True ex: get_mol_neutralized_with_dimorphite : fonction qui renvoie une molécule neutralisée en utilisant la méthode proposée par Dimorphite-dl.
by	by est utilisé pour préciser le nom d’une fonction faisant un traitement basé sur une propriété particulier: ex: sort_Lmol_by_nat, fonction qui trie Lmol par nombre d’atomes.
sort	sort est utilisé avec les fonctions réalisant un tri ex: sort_Lmol_by_prop, fonction triant les molécules en fonction d’une de ces propriétés.
fuse	fuse est utilisé avec les fonctions réalisant une fusion d’éléments ex: fuse_LL_in_L, fonction fusionnant une liste de listes en une liste ex: fuse_LM_in_M, fonction fusionnant une liste de numpy arrays en un numpy array
split	split est utilisé avec les fonctions réalisant une décomposition d’un éléments en un liste d’élements ex: split_L_in_LL, fonction décomposant une liste en une liste de listes.