Coverage for nodimo / __init__.py: 100%

1# ┓• Licensed under the MIT License 

2# ┏┓┏┓┏┫┓┏┳┓┏┓ Copyright (c) 2024 Rodrigo Castro 

3# ┛┗┗┛┗┻┗┛┗┗┗┛ https://nodimo.readthedocs.io 

4# ASCII Art (Font Tmplr) by https://patorjk.com 

5 

6""" 

7Nodimo 

8====== 

9 

10Nodimo is a tool that creates dimensionless models. 

11 

12The main purpose of Nodimo is to transform a dimensional relationship 

13between quantities into a dimensionless one. This is done by grouping 

14dimensional quantities into dimensionless products in such a way that 

15the resulting number of products is always lower than or equal to the 

16starting number of quantities. Therefore, the ensuing dimensionless 

17model is, at the same time, a generalization and simplification of the 

18dimensional model. 

19 

20Nodimo supports any number of dimensions and quantities. It can be used 

21for applications in science, engineering, economics and finance. The 

22resulting dimensionless relations can be used as the basis for further 

23studies in similarity and model testing. 

24 

25Notes 

26----- 

27The use of Nodimo requires basic knowledge of dimensional analysis, 

28specially on choosing the appropriate set of scaling parameters and 

29indentifying established dimensionless groups. It is recommended the 

30use of IPython/Jupyter for a better displaying of the results. 

31 

32Modules 

33------- 

34dimension 

35 This module contains the class to create a quantity dimension. 

36quantity 

37 This module contains the class to create a quantity. 

38power 

39 This module contains the class to create a power of a quantity. 

40product 

41 This module contains the class to create a product of quantities. 

42collection 

43 This module contains the base class for everything that is created 

44 with a collection of quantities. 

45groups 

46 This module contains classes to create groups of quantities, which 

47 are specific types of collections. 

48matrix 

49 This module contains the class to create a dimensional matrix. 

50relation 

51 This module contains the class to create a relation between 

52 quantities. 

53model 

54 This module contains the classes to create (non)dimensional models. 

55""" 

56 

57from nodimo.quantity import Quantity, Q 6 ctx1abcdef

58from nodimo.power import Power 6 ctx1abcdef

59from nodimo.product import Product 6 ctx1abcdef

60from nodimo.matrix import DimensionalMatrix 6 ctx1abcdef

61from nodimo.relation import Relation 6 ctx1abcdef

62from nodimo.model import Model 6 ctx1abcdef

63 

64__all__ = [ 6 ctx1abcdef

65 'Quantity', 

66 'Q', 

67 'Power', 

68 'Product', 

69 'DimensionalMatrix', 

70 'Relation', 

71 'Model', 

72]