This repository has been archived by the owner on Feb 15, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
texts.py
181 lines (156 loc) · 7.91 KB
/
texts.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
from dash import html
import dash_bootstrap_components as dbc
kiara = html.Div(children=[
html.P("Kiara is a data orchestration engine that uses a modular approach to let users re-use tried and tested data pipelines, as well as create new ones from existing building blocks."),
html.H5("Github Repo:",className="mb-1"),
dbc.ListGroup(
[
dbc.ListGroupItem('Kiara - https://github.com/DHARPA-Project/kiara', href="https://github.com/DHARPA-Project/kiara"),
], flush=True
),
dbc.CardImg(src="static/images/kiara.png", top=True),
])
modules_users = html.Div(children=[
html.P("Modules users are Kiara users who may not be comfortable with coding, but who are able to use the command-line. They can access Kiara functionalities via the command-line interface, create pipelines with existing Kiara modules, and store processed data in the data registry."),
html.Br(),
html.H5("Tutorials",className="mb-1"),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Getting started with Kiara": https://dharpa.org/kiara.documentation/latest/usage/getting_started/', href="https://dharpa.org/kiara.documentation/latest/usage/getting_started/"),
dbc.ListGroupItem('"Assembling a pipeline": https://dharpa.org/kiara.documentation/latest/extending_kiara/pipelines/assemble_pipelines/', href="https://dharpa.org/kiara.documentation/latest/extending_kiara/pipelines/assemble_pipelines/"),
], flush=True
),
html.Br(),
dbc.CardImg(src="static/images/modules_users.png", top=True),
])
modules_creators = html.Div(children=[
html.P("Modules creators are Kiara users who are comfortable with coding. In addition to the functionalities available to workflow creators, they can create their own modules, by using a plugin project template."),
html.Br(),
html.H5("Tutorials:",className="mb-1"),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Creating modules": https://dharpa.org/kiara.documentation/latest/extending_kiara/creating_modules/', href="https://dharpa.org/kiara.documentation/latest/extending_kiara/creating_modules/"),
dbc.ListGroupItem('"Assembling a pipeline": https://dharpa.org/kiara.documentation/latest/extending_kiara/pipelines/assemble_pipelines/', href="https://dharpa.org/kiara.documentation/latest/extending_kiara/pipelines/assemble_pipelines/"),
], flush=True
),
html.Br(),
dbc.CardImg(src="static/images/modules_creators.png", top=True),
])
app_creators = html.Div(children=[
html.P("App creators are module creators who use low code front-end apps such as Streamlit or Dash. They can use Kiara as the pipeline execution tool for their projects via Kiara Python API."),
html.Br(),
html.H5("Documentation:",className="mb-1"),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Kiara Python API": https://dharpa.org/kiara/latest/reference/kiara/interfaces/python_api/__init__/', href="https://dharpa.org/kiara/latest/reference/kiara/interfaces/python_api/__init__/"),
], flush=True
),
html.Br(),
dbc.CardImg(src="static/images/app_creators.png", top=True),
])
fe_dev = html.Div(children=[
html.P("Front-End developers can request Kiara REST API and retrieve responses formatted in JSON. Additionally, the workflow API, currently under development, is a tool enabling them to explore the possibilities in terms of Kiara workflow sessions."),
html.Br(),
html.H5("Example:",className="mb-1"),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Kiara Workflow Object": https://dharpa.org/kiara.documentation/latest/workflows/topic_modeling/', href="https://dharpa.org/kiara.documentation/latest/workflows/topic_modeling/"),
], flush=True
),
html.Br(),
dbc.CardImg(src="static/images/fe_dev.png", top=True),
])
cli = html.Div(children=[
html.P("Operations can be performed via the command-line, such as viewing available modules and pipelines, and running them."),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/cli_2.png", top=True),
html.Br(),
dbc.CardImg(src="static/images/cli_3.png", top=True),
])
data_registry = html.Div(children=[
html.P("The data registry enables to store data locally. It is architectured to capture information-rich metadata, such as lineage information."),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/cli_lineage.png", top=True),
])
pipeline = html.Div(children=[
html.P("Pipelines enable users to assemble module and to define some outputs as the input of the following module. The pipeline can be created via a yaml file."),
html.Br(),
html.H5("Example:",className="mb-1"),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Example": https://github.com/DHARPA-Project/kiara.examples/blob/main/examples/pipelines/topic_modeling/topic_modeling.yaml', href='https://github.com/DHARPA-Project/kiara.examples/blob/main/examples/pipelines/topic_modeling/topic_modeling.yaml'),
], flush=True
),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/pipeline_1.png", top=True),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/pipeline_2.png", top=True),
])
plugin = html.Div(children=[
html.P("A kiara plugin is a template that provides module creators with a template to add their own modules. Modules template structure is designed to facilitate the documentation by modules creators."),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Kiara Plugin Template": https://github.com/DHARPA-Project/kiara_plugin.develop', href='https://github.com/DHARPA-Project/kiara_plugin.develop'),
], flush=True
),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/plugin.png", top=True),
])
python_api = html.Div(children=[
html.P("The Python API provides methods to use Kiara outside the command-line interface, with Python code."),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Documentation": https://dharpa.org/kiara/latest/reference/kiara/interfaces/python_api/__init__/', href="https://dharpa.org/kiara/latest/reference/kiara/interfaces/python_api/__init__/"),
dbc.ListGroupItem('"Example": https://github.com/DHARPA-Project/kiara_plugin.anom_processing/blob/develop/examples/jupyter/preprocessing_prep.ipynb', href='https://github.com/DHARPA-Project/kiara_plugin.anom_processing/blob/develop/examples/jupyter/preprocessing_prep.ipynb'),
], flush=True
),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/python_api.png", top=True),
])
workflow_object = html.Div(children=[
html.P("The workflow object enables front-end developers to experiment with Kiara's session storage that is under development. It provides a way to retrieve information such as the history of inputs or the status of a workflow."),
html.Br(),
dbc.ListGroup(
[
dbc.ListGroupItem('"Documentation": https://dharpa.org/kiara.documentation/latest/workflows/', href="https://dharpa.org/kiara.documentation/latest/workflows/"),
dbc.ListGroupItem('"Example": https://dharpa.org/kiara.documentation/latest/workflows/topic_modeling/', href='https://dharpa.org/kiara.documentation/latest/workflows/topic_modeling/'),
], flush=True
),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/workflow_object.png", top=True),
])
rest_api = html.Div(children=[
html.P("Kiara Python REST Api provides front-end developers with endpoints to retrieve data in JSON and Html."),
html.Br(),
html.Br(),
dbc.CardImg(src="static/images/api_lineage.png", top=True),
])
texts_keys = {
"Kiara": kiara,
"Kiara Personas": kiara,
"Modules Pipelines Users": modules_users,
"Modules Pipelines Creators": modules_creators,
"Pipeline-Apps Creators": app_creators,
"Front-End Developers": fe_dev,
"CLI": cli,
"Data registry": data_registry,
"Pipeline": pipeline,
"Plugin": plugin,
"Python API": python_api,
"Workflow object": workflow_object,
"Rest API": rest_api
}