The vwadaptor repository contains the server code for our modeling API. The current deployment can be accessed from https://modelserver.virtualwatershed.org/api/.

The best way to get started using the modeling server and other Virtual Watershed tools is to follow the deployment instructions and usage examples on vw-deploy. That requires some knowledge of Docker, which can be gained by following instructions and tutorials at docker.com.

First, set your app's secret key as an environment variable. For example, add the following to .bashrc or .bash_profile.

export VWADAPTOR_SECRET='something-really-secret'

Then run the following commands to bootstrap your environment.

git clone https://github.com/itsrifat/vwadaptor
cd vwadaptor
pip install -r requirements/dev.txt
python manage.py server

You will see a pretty welcome screen.

Once you have installed your DBMS (sqlite3 will do for development), run the following to create your app's database tables and perform the initial "migration," which creates the databases with the appropriate columns to match the models found in the corresponding subdirectories of vwadaptor, e.g. vwadaptor/modelrun/models.py, vwadaptor/modelresource, etc.:

python manage.py db init
python manage.py db migrate
python manage.py db upgrade
python manage.py server

In your production environment, make sure the VWADAPTOR_ENV environment variable is set to "prod".

To open the interactive shell, run

python manage.py shell

By default, you will have access to app, db, and the User model.

To run all tests, run

python manage.py test

Whenever a database migration needs to be made. Run the following commands:

python manage.py db migrate

This will generate a new migration script. Then run:

python manage.py db upgrade

To apply the migration.

For a full migration command reference, run python manage.py db --help.