Skip to main content

ParFlow sandtank using trame

Project description

ParFlow sandtank using trame

  • Free software: Apache Software License

Development

Create a virtual environment

python3 -m venv .venv
source .venv/bin/activate
pip install -U pip

Build and install ParFlow if not available on your system. Please look are Linux.readme or MacM1.readme for additional system requiements.

./parflow/build-parflow.sh
./parflow/build-ecoslim.sh

Build and install the Vue components

cd vue-components
npm i
npm run build
cd -

Install the application

pip install -e .

Run the application

source ./parflow/activate.sh # Only if parflow is not already available
trame-sandtank --input ./templates/default --output ./data

Usage / testing

You will need to run the following set of command line once

# get code
git clone git@github.com:HydroFrame-ML/trame-sandtank.git
cd trame-sandtank

# create venv
python3 -m venv .venv # use 3.9 on Mac M1
source .venv/bin/activate
pip install -U pip

# create a local ParFlow + EcoSLIM
./parflow/build-parflow.sh
./parflow/build-ecoslim.sh

# install sandtank
pip install .

Then once your environment is setup, you can execute the sandtank application by running the following command lines.

# Activate venv + parflow
source .venv/bin/activate
source ./parflow/activate.sh

# Run a given template
trame-sandtank --input ./templates/default --output ./data

To use your own ParFlow + EcoSLIM just set PARFLOW_DIR and ECOSLIM_EXEC environment variables.

To try within Jupyter once you’ve installed it by pip install jupyterlab

# Activate venv + parflow
source .venv/bin/activate
source ./parflow/activate.sh

# Run a given template
jupyter-lab

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trame-sandtank-1.0.0.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

trame_sandtank-1.0.0-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

Details for the file trame-sandtank-1.0.0.tar.gz.

File metadata

  • Download URL: trame-sandtank-1.0.0.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for trame-sandtank-1.0.0.tar.gz
Algorithm Hash digest
SHA256 31356830ccbb77cf0e338dbe9ac77f1bb35e0daf1e6c4892835c99770c174eaf
MD5 817203aec8d63125ca5b9b3cb18a1a3a
BLAKE2b-256 1c64f0fd4cedaabff07148d32f13aaad086bb4da1f198e94a1e4fad28b54cfae

See more details on using hashes here.

Provenance

File details

Details for the file trame_sandtank-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: trame_sandtank-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.26.0 requests-toolbelt/0.9.1 urllib3/1.26.7 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for trame_sandtank-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 addb10372a2c4900a748af1e37e969a95e5b0a8c98c9e3ec094648f9fc51bc2e
MD5 a85851f5cc9dd20a260ad689937f22e0
BLAKE2b-256 eff48f4eb0f0a897ae5da64edb6c8821e927e5480c96d2a7742322bc976a798e

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page