Custom Dash components for use in Webviz
Project description
Webviz subsurface components
webviz_subsurface_components
is a Dash component library for use in webviz
.
You can quickly get started with:
- Run
pip install webviz-subsurface-components
- Run
python examples/example_hm.py
- Visit http://localhost:8050 in your web browser
Contributing
This project was generated by the dash-component-boilerplate. It contains the minimal set of code required to create a custom Dash component.
Install dependencies
If you have selected install_dependencies during the prompt, you can skip this part.
-
Install npm packages
npm install
-
Create a virtual env and activate.
virtualenv venv . venv/bin/activate
Note: venv\Scripts\activate for windows
-
Install python packages required to build components.
pip install .[dependencies] pip install dash[dev]
-
Install the python packages for testing (optional)
pip install .[tests] pip install dash[testing]
The second of these commands appears to be necessary as long as this
pip
issue is open.
Write component code in src/lib/components/<component_name>.react.js
-
The demo app is in
src/demo
and you will import your example component code into your demo app. -
Test your code in a Python environment:
- Build your code
npm run build:all
- Run and modify the
usage.py
sample dash app:python usage.py
- Build your code
-
Write tests for your component.
-
A sample test is available in
tests/test_usage.py
, it will loadusage.py
and you can then automate interactions with selenium. -
Run the tests with
pytest tests
. -
The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. dash-core-components).
-
-
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.
-
Build code and install
- Build your code:
npm run build:all
- Install the Python package:
pip install -e .
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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aebb6d12d76f968c46660f00456bfdd825c3cb8c51fd72d6c5c4679c195c725d |
|
MD5 | c500635bbd2d8fb4e23415f26214fd58 |
|
BLAKE2b-256 | ff0f084ea847dc7995ef4e5e6c639bf607f1d70224d6e332e66f1db78d86a371 |