Custom Dash components for use in Webviz
Project description
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:
- Run
pip install webviz-subsurface-components
- Run
python examples/example_hm.py
- Visit http://localhost:8050 in your web browser
This project was originally generated by the 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:
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:
- Install npm packages
npm ci --ignore-scripts --prefix ./react
- 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
- Install python packages required to build components.
pip install .[dependencies] pip install dash[dev]
- 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, runnpm start
. -
To test your code in a Python environment:
- Build your code
npm run build --prefix ./react
- Install the Python pacakge in development mode (if not already done and
assuming you are using a virtual environment):
pip install -e .
- Create a new example in
examples/
which uses your new component.
- Build your code
-
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
.
- Tests exist in
-
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 inwebviz_subsurface_components/__init__.py
so dash will serve them automatically when the component suite is requested.
- Make sure that they are referenced in
-
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.:
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
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for webviz_subsurface_components-0.4.15rc5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 998e26b2cf62eb620d5134451de60fd4287c08f61add752d6da91894bfa1cefc |
|
MD5 | 0e2cc30009ce15d480e3e4beeb35b9b9 |
|
BLAKE2b-256 | d3b2bd8c6bcbd5b2a678999246e5482efa7dc041e6ee2d0369d54cc9478c31a1 |
Hashes for webviz_subsurface_components-0.4.15rc5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6837c05550526e2a9b7a4df9acb8e044e5c0805dc73ed1f4d068ead4e921b79 |
|
MD5 | ae453fec3a079d1fdc9eb9b47be9b9a5 |
|
BLAKE2b-256 | fa67f939b5559bea96260e0f0d9e7b0de2cdaaf07e746b837be6445df20213af |