Custom Dash components for use in Webviz


Keywords
dash, javascript, react, subsurface, webviz
License
Other
Install
pip install webviz-subsurface-components==0.0.19

Documentation

PyPI version Build Status Codacy Badge Python 3.6 | 3.7 | 3.8 Code style: black code style: prettier

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:

  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. (with some modifications).

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
    
  2. Run the project's own postinstall script
    npm run postinstall
    
  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]
    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 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:all
      
    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.