summaryrefslogtreecommitdiff
path: root/python-webviz-subsurface-components.spec
blob: 9239b4564634b906342a853478f4640d4f111427 (plain)
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
%global _empty_manifest_terminate_build 0
Name:		python-webviz-subsurface-components
Version:	0.4.15
Release:	1
Summary:	Custom Dash components for use in Webviz
License:	MPL
URL:		https://github.com/equinor/webviz-subsurface-components
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/3d/e1/5abfe8e6a28b7b37bf3f942bd25c2167fd2bb329c4ce062031043e704cf1/webviz_subsurface_components-0.4.15.tar.gz
BuildArch:	noarch

Requires:	python3-dash
Requires:	python3-numpy
Requires:	python3-pandas
Requires:	python3-dash
Requires:	python3-numpy
Requires:	python3-pandas
Requires:	python3-bandit
Requires:	python3-black
Requires:	python3-dash[testing]
Requires:	python3-geojson
Requires:	python3-jsonpatch
Requires:	python3-jsonpointer
Requires:	python3-matplotlib
Requires:	python3-orjson
Requires:	python3-Pillow
Requires:	python3-pylint
Requires:	python3-scipy
Requires:	python3-selenium
Requires:	python3-vtk
Requires:	python3-webviz-core-components
Requires:	python3-xtgeo

%description
[![PyPI version](https://badge.fury.io/py/webviz-subsurface-components.svg)](https://badge.fury.io/py/webviz-subsurface-components)
[![npm version](https://badge.fury.io/js/%40webviz%2Fsubsurface-components.svg)](https://badge.fury.io/js/%40webviz%2Fsubsurface-components)
[![Build Status](https://github.com/equinor/webviz-subsurface-components/workflows/webviz-subsurface-components/badge.svg)](https://github.com/equinor/webviz-subsurface-components/actions?query=branch%3Amaster)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/alerts/)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/context:javascript)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/context:python)
[![Python 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10-blue.svg)](https://www.python.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black%20%28Python%29-000000.svg)](https://github.com/psf/black)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier%20%28JavaScript%29-ff69b4.svg)](https://github.com/prettier/prettier)
[![codecov](https://codecov.io/gh/equinor/webviz-subsurface-components/branch/master/graph/badge.svg?token=TKBZPHQLU4)](https://codecov.io/gh/equinor/webviz-subsurface-components)

# Webviz subsurface components

`webviz_subsurface_components` is a Dash/React component library for use in `webviz`,
which have in common that they are geared towards subsurface dashboards. There storybook is available at https://equinor.github.io/webviz-subsurface-components/storybook-static.
And the demo of old components is available at https://equinor.github.io/webviz-subsurface-components.

## How to install the components

You can quickly get started using the components in Dash by:

1.  Run `pip install webviz-subsurface-components`
2.  Run `python examples/example_hm.py`
3.  Visit http://localhost:8050 in your web browser

This project was originally generated by the
[dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate).
(with some modifications).

If you are only interested in using the JavaScript code in your own JavaScript project,
you can install the [`npmjs` deployed version](https://www.npmjs.com/package/@webviz/subsurface-components):
```
npm i @webviz/subsurface-components
```
## How to contribute

### Install dependencies

If you want to build and develop yourself, you should fork + clone the repository, and
then:

1. Install npm packages
    ```
    npm ci --ignore-scripts --prefix ./react
    ```
2. Run some potentially optional postinstall scripts
    ```
    npm run setup-deckgl-types --prefix ./react  # only needed if ignored scripts during install
    npm run copy-package-json --prefix ./react  # only needed if building Dash components
    ```
3. Install python packages required to build components.
    ```
    pip install .[dependencies]
    pip install dash[dev]
    ```
4. Install the python packages for testing.
    ```
    pip install .[tests]
    ```

### Write component code in `src/lib/components/<component_name>/<component_name>.jsx`

- The demo app is in `src/demo` and is where you will import an example of your
  component. To start the existing demo app, run `npm start`.
- To test your code in a Python environment:
    1. Build your code
        ```
        npm run build --prefix ./react
        ```
    2. Install the Python pacakge in development mode (if not already done and
       assuming you are using a virtual environment):
        ```
        pip install -e .
        ```
    3. Create a new example in `examples/` which uses your new component.

-   Write tests for your component.
    -   Tests exist in `tests/`. Take a look at them to see how to write tests using
        the Dash test framework.
    -   Run the tests with `pytest tests`.

-   Add custom styles to your component by putting your custom CSS files into
    your distribution folder (`webviz_subsurface_components`).
    -   Make sure that they are referenced in `MANIFEST.in` so that they get
        properly included when you're ready to publish your component.
    -   Make sure the stylesheets are added to the `_css_dist` dict in
        `webviz_subsurface_components/__init__.py` so dash will serve them
        automatically when the component suite is requested.

- Every file related to the component should be located in the component directory, unless the file is shared between multiple components. For example the file-structure should look something like this:
```
src
|--lib
    |----<component_name>
        |----components
              |----<sub_component>.ts
        |----utils
        |----<component_name>.tsx
        |----<component_name>.css
        |----index.ts
```

### Automatically upload demo application

This repository has a GitHub workflow which can automatically build and deploy a demo
app with your changes, to GitHub pages.

- On push to your feature branch, in your fork, the workflow will build and deploy a
  demo app to your fork's GitHub page, given that your commit message includes the
  substring `[deploy test]`.
- On merge to `master` in the main repository, a build + deploy will be done to the
  official GitHub page in the main repository.

For this to work in your own fork, you will need to create a branch `gh-pages`
(this you only need to do once). One way of creating this branch is e.g.:
```bash
git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m  "Create GitHub pages branch"
git push origin gh-pages
```

You are encouraged to rebase and squash/fixup unnecessary commits before pull request is merged to `master`.


%package -n python3-webviz-subsurface-components
Summary:	Custom Dash components for use in Webviz
Provides:	python-webviz-subsurface-components
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-webviz-subsurface-components
[![PyPI version](https://badge.fury.io/py/webviz-subsurface-components.svg)](https://badge.fury.io/py/webviz-subsurface-components)
[![npm version](https://badge.fury.io/js/%40webviz%2Fsubsurface-components.svg)](https://badge.fury.io/js/%40webviz%2Fsubsurface-components)
[![Build Status](https://github.com/equinor/webviz-subsurface-components/workflows/webviz-subsurface-components/badge.svg)](https://github.com/equinor/webviz-subsurface-components/actions?query=branch%3Amaster)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/alerts/)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/context:javascript)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/context:python)
[![Python 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10-blue.svg)](https://www.python.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black%20%28Python%29-000000.svg)](https://github.com/psf/black)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier%20%28JavaScript%29-ff69b4.svg)](https://github.com/prettier/prettier)
[![codecov](https://codecov.io/gh/equinor/webviz-subsurface-components/branch/master/graph/badge.svg?token=TKBZPHQLU4)](https://codecov.io/gh/equinor/webviz-subsurface-components)

# Webviz subsurface components

`webviz_subsurface_components` is a Dash/React component library for use in `webviz`,
which have in common that they are geared towards subsurface dashboards. There storybook is available at https://equinor.github.io/webviz-subsurface-components/storybook-static.
And the demo of old components is available at https://equinor.github.io/webviz-subsurface-components.

## How to install the components

You can quickly get started using the components in Dash by:

1.  Run `pip install webviz-subsurface-components`
2.  Run `python examples/example_hm.py`
3.  Visit http://localhost:8050 in your web browser

This project was originally generated by the
[dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate).
(with some modifications).

If you are only interested in using the JavaScript code in your own JavaScript project,
you can install the [`npmjs` deployed version](https://www.npmjs.com/package/@webviz/subsurface-components):
```
npm i @webviz/subsurface-components
```
## How to contribute

### Install dependencies

If you want to build and develop yourself, you should fork + clone the repository, and
then:

1. Install npm packages
    ```
    npm ci --ignore-scripts --prefix ./react
    ```
2. Run some potentially optional postinstall scripts
    ```
    npm run setup-deckgl-types --prefix ./react  # only needed if ignored scripts during install
    npm run copy-package-json --prefix ./react  # only needed if building Dash components
    ```
3. Install python packages required to build components.
    ```
    pip install .[dependencies]
    pip install dash[dev]
    ```
4. Install the python packages for testing.
    ```
    pip install .[tests]
    ```

### Write component code in `src/lib/components/<component_name>/<component_name>.jsx`

- The demo app is in `src/demo` and is where you will import an example of your
  component. To start the existing demo app, run `npm start`.
- To test your code in a Python environment:
    1. Build your code
        ```
        npm run build --prefix ./react
        ```
    2. Install the Python pacakge in development mode (if not already done and
       assuming you are using a virtual environment):
        ```
        pip install -e .
        ```
    3. Create a new example in `examples/` which uses your new component.

-   Write tests for your component.
    -   Tests exist in `tests/`. Take a look at them to see how to write tests using
        the Dash test framework.
    -   Run the tests with `pytest tests`.

-   Add custom styles to your component by putting your custom CSS files into
    your distribution folder (`webviz_subsurface_components`).
    -   Make sure that they are referenced in `MANIFEST.in` so that they get
        properly included when you're ready to publish your component.
    -   Make sure the stylesheets are added to the `_css_dist` dict in
        `webviz_subsurface_components/__init__.py` so dash will serve them
        automatically when the component suite is requested.

- Every file related to the component should be located in the component directory, unless the file is shared between multiple components. For example the file-structure should look something like this:
```
src
|--lib
    |----<component_name>
        |----components
              |----<sub_component>.ts
        |----utils
        |----<component_name>.tsx
        |----<component_name>.css
        |----index.ts
```

### Automatically upload demo application

This repository has a GitHub workflow which can automatically build and deploy a demo
app with your changes, to GitHub pages.

- On push to your feature branch, in your fork, the workflow will build and deploy a
  demo app to your fork's GitHub page, given that your commit message includes the
  substring `[deploy test]`.
- On merge to `master` in the main repository, a build + deploy will be done to the
  official GitHub page in the main repository.

For this to work in your own fork, you will need to create a branch `gh-pages`
(this you only need to do once). One way of creating this branch is e.g.:
```bash
git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m  "Create GitHub pages branch"
git push origin gh-pages
```

You are encouraged to rebase and squash/fixup unnecessary commits before pull request is merged to `master`.


%package help
Summary:	Development documents and examples for webviz-subsurface-components
Provides:	python3-webviz-subsurface-components-doc
%description help
[![PyPI version](https://badge.fury.io/py/webviz-subsurface-components.svg)](https://badge.fury.io/py/webviz-subsurface-components)
[![npm version](https://badge.fury.io/js/%40webviz%2Fsubsurface-components.svg)](https://badge.fury.io/js/%40webviz%2Fsubsurface-components)
[![Build Status](https://github.com/equinor/webviz-subsurface-components/workflows/webviz-subsurface-components/badge.svg)](https://github.com/equinor/webviz-subsurface-components/actions?query=branch%3Amaster)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/alerts/)
[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/context:javascript)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/equinor/webviz-subsurface-components.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/equinor/webviz-subsurface-components/context:python)
[![Python 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.8%20|%203.9%20|%203.10-blue.svg)](https://www.python.org/)
[![Code style: black](https://img.shields.io/badge/code%20style-black%20%28Python%29-000000.svg)](https://github.com/psf/black)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier%20%28JavaScript%29-ff69b4.svg)](https://github.com/prettier/prettier)
[![codecov](https://codecov.io/gh/equinor/webviz-subsurface-components/branch/master/graph/badge.svg?token=TKBZPHQLU4)](https://codecov.io/gh/equinor/webviz-subsurface-components)

# Webviz subsurface components

`webviz_subsurface_components` is a Dash/React component library for use in `webviz`,
which have in common that they are geared towards subsurface dashboards. There storybook is available at https://equinor.github.io/webviz-subsurface-components/storybook-static.
And the demo of old components is available at https://equinor.github.io/webviz-subsurface-components.

## How to install the components

You can quickly get started using the components in Dash by:

1.  Run `pip install webviz-subsurface-components`
2.  Run `python examples/example_hm.py`
3.  Visit http://localhost:8050 in your web browser

This project was originally generated by the
[dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate).
(with some modifications).

If you are only interested in using the JavaScript code in your own JavaScript project,
you can install the [`npmjs` deployed version](https://www.npmjs.com/package/@webviz/subsurface-components):
```
npm i @webviz/subsurface-components
```
## How to contribute

### Install dependencies

If you want to build and develop yourself, you should fork + clone the repository, and
then:

1. Install npm packages
    ```
    npm ci --ignore-scripts --prefix ./react
    ```
2. Run some potentially optional postinstall scripts
    ```
    npm run setup-deckgl-types --prefix ./react  # only needed if ignored scripts during install
    npm run copy-package-json --prefix ./react  # only needed if building Dash components
    ```
3. Install python packages required to build components.
    ```
    pip install .[dependencies]
    pip install dash[dev]
    ```
4. Install the python packages for testing.
    ```
    pip install .[tests]
    ```

### Write component code in `src/lib/components/<component_name>/<component_name>.jsx`

- The demo app is in `src/demo` and is where you will import an example of your
  component. To start the existing demo app, run `npm start`.
- To test your code in a Python environment:
    1. Build your code
        ```
        npm run build --prefix ./react
        ```
    2. Install the Python pacakge in development mode (if not already done and
       assuming you are using a virtual environment):
        ```
        pip install -e .
        ```
    3. Create a new example in `examples/` which uses your new component.

-   Write tests for your component.
    -   Tests exist in `tests/`. Take a look at them to see how to write tests using
        the Dash test framework.
    -   Run the tests with `pytest tests`.

-   Add custom styles to your component by putting your custom CSS files into
    your distribution folder (`webviz_subsurface_components`).
    -   Make sure that they are referenced in `MANIFEST.in` so that they get
        properly included when you're ready to publish your component.
    -   Make sure the stylesheets are added to the `_css_dist` dict in
        `webviz_subsurface_components/__init__.py` so dash will serve them
        automatically when the component suite is requested.

- Every file related to the component should be located in the component directory, unless the file is shared between multiple components. For example the file-structure should look something like this:
```
src
|--lib
    |----<component_name>
        |----components
              |----<sub_component>.ts
        |----utils
        |----<component_name>.tsx
        |----<component_name>.css
        |----index.ts
```

### Automatically upload demo application

This repository has a GitHub workflow which can automatically build and deploy a demo
app with your changes, to GitHub pages.

- On push to your feature branch, in your fork, the workflow will build and deploy a
  demo app to your fork's GitHub page, given that your commit message includes the
  substring `[deploy test]`.
- On merge to `master` in the main repository, a build + deploy will be done to the
  official GitHub page in the main repository.

For this to work in your own fork, you will need to create a branch `gh-pages`
(this you only need to do once). One way of creating this branch is e.g.:
```bash
git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m  "Create GitHub pages branch"
git push origin gh-pages
```

You are encouraged to rebase and squash/fixup unnecessary commits before pull request is merged to `master`.


%prep
%autosetup -n webviz-subsurface-components-0.4.15

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-webviz-subsurface-components -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.4.15-1
- Package Spec generated