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.
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).
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
- Run the project's own
postinstall
scriptnpm run postinstall
- Install python packages required to build components.
pip install .[dependencies] pip install dash[dev]
- Install the python packages for testing.
The second of these commands appears to be necessary as long as thispip install .[tests] pip install dash[testing]
pip
issue is open.
Write component code in src/lib/components/<component_name>.react.js
-
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:all
- 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
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
Hashes for webviz_subsurface_components-0.0.24.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b25592f7f282b162d5d3e4879206fc46a5494f1455aaa45c0e9e8ddd144c86ed |
|
MD5 | 5cfa388b446fdcd188a71e44600259d9 |
|
BLAKE2b-256 | a07206f8084f79d30968d6dcf069a6ab0ec1e37de21856e2e582b6db0cfddf30 |