Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.65 KB

README.md

File metadata and controls

21 lines (15 loc) · 1.65 KB
Raw

user-templates-api

This repository handles templates for the workspaces feature in the HuBMAP Data Portal. Templates are pre-set notebooks with analyses that can be added to a workspace. Variables linked to a workspace (such as the datasets added to the workspace) can be added into the templates.

Contributing

We welcome contributions! Please see our contributing guidelines. For adding new templates, please see our template contributing guidelines.

We also have a slack channel for feedback on the workspaces. Please reach out to the HuBMAP Help Desk ([email protected]) to get in touch.

Deploying User Templates Locally

  • Clone the repository.
  • Generate a virtual environment (virtualenv -p python3.9 venv).
  • Activate the virtual environment (source venv/bin/activate).
  • Install the requirements (pip install -r requirements.txt).
  • Create a config file (cp src/example_config.json src/config.json) and update it with appropriate values.
  • Run database migration (python src/manage.py migrate).
  • Start the server (python src/manage.py runserver).

Contributors

This project is part of the HuBMAP consortium. The main contributors to the workspaces are the Pittsburgh Supercomputing Center and the HIDIVE Lab at Harvard Medical School.