| All | Windows | Mac |
|---|---|---|
The AdhModel object contains all the data necessary to describe an AdH model. Each AdhModel contains an AdhMesh object and each mesh object contains one or more AdhSimulation objects.
The AdhModel object is not directly tied to any visualization package. While it does contain Holoviews objects, these may be rendered with either Bokeh or Matplotlib. AdhModel has its own visualization package, AdhUI (https://github.com/erdc/AdhUI).
To install this packaged from conda:
conda install -c erdc -c pyviz/label/dev -c conda-forge adhmodel
To create an environment from the adhmodel conda package (which is on the erdc conda channel), all of the channel dependencies must be included:
conda create -n adhmodel -c erdc -c conda-forge -c aquaveo -c pyviz/label/dev adhmodel
- AdhModel
- AdhMesh
- AdhSimulation
- AdhMesh
AdhModel inherits from the GeneSIs base Model class. AdhMesh inherits from the GeneSIs base Mesh classes. AdhSimulation inherits from the GeneSIs base Simulation class.
Each model object contains one mesh object. A mesh object may have one or more simulations. While this package is not the proper location for visualizations, the mesh class does contain several convenience functions for viewing the mesh.
The simulation object is the container for the boundary conditions and the initial conditions for a simulation. Additionally, the results, if available, are also located in the AdHSimulation object. Each mesh may contain one or more simulations. For example, for a model which is analyzing base versus plan, there will be two simulation objects - one each for base and plan.
To install the repository from source:
conda env create -f environment.yml -n adhmodel
conda activate adhmodel
jupyter labextension install @pyviz/jupyterlab_pyviz
To opt out of a Azure Pipelines CI build, add [skip ci] or [ci skip] to the commit message.