HydroShare is a website and hydrologic information system for sharing hydrologic data and models aimed at giving users the cyberinfrastructure needed to innovate and collaborate in research to solve water problems.
Jenkins CI (develop branch)Nightly Build Status generated by
HydroShare is a website and hydrologic information system for sharing hydrologic data and models aimed at providing the cyberinfrastructure needed to enable innovation and collaboration in research to solve water problems. HydroShare is designed to advance hydrologic science by enabling the scientific community to more easily and freely share products resulting from their research, not just the scientific publication summarizing a study, but also the data and models used to create the scientific publication. With HydroShare users can: (1) share data and models with colleagues; (2) manage who has access to shared content; (3) share, access, visualize and manipulate a broad set of hydrologic data types and models; (4) use the web services API to program automated and client access; (5) publish data and models to meet the requirements of research project data management plans; (6) discover and access data and models published by others; and (7) use web apps to visualize, analyze, and run models on data in HydroShare.
More information can be found in our Wiki Pages
This README file is for developers interested in working on the Hydroshare code itself, or for developers or researchers learning about how the application works at a deeper level. If you simply want to use the application, go to http://hydroshare.org and register an account.
If you want to install and run the source code of application locally and/or contribute to development, read on.
VirtualBox development environment
To quickly get started developing we offer a preconfigured development environment encapsulated within a virtual box Virtual Machine (VM). This includes the appropriate version of Ubuntu, Python, Docker, and other key dependencies and development tools.
Simplified Installation Instructions
- Download the latest OVA file here
- Open the .OVA file with VirtualBox, this will create a guest VM
- Follow the instructions here to share a local hydroshare folder with your guest VM
- Start the guest VM
- Log into the guest VM with either ssh or the GUI. The default username/password is hydro:hydro
- From the root directory
/home/hydro, clone this repository into the hydroshare folder
cdinto the hydroshare folder and run
./hsctl rebuild --dbto build the application and run it
- If all goes well, your local version of Hydroshare should be running at http://192.168.56.101:8000
For more detailed installation, please see this document: Getting Started with HydroShare
For all intents and purposes, Hydroshare is a large Python/Django application with some extra features and technologies added on:
- SOLR for searching
- Redis for caching
- RabbitMQ for concurrency and serialization
- iRODS for a federated file system
- PostgreSQL for the database backend
hsctl script is your primary tool in interacting with and running tasks against your Hydroshare install. It has the syntax
./hsccl [command] where
[command] is one of:
loaddb: Deletes existing database and reloads the database specified in the
managepy [args]: Executes a
python manage.py [args]call on the running hydroshare container.
maint_off: Removes the maintenance page from view (only if NGINX is being used).
maint_on: Displays the maintenance page in the browser (only if NGINX is being used).
rebuild: Stops, removes and deletes only the hydroshare docker containers and images while retaining the database contents on the subsequent build as defined in the
rebuild --db: Fully stops, removes and deletes any prior hydroshare docker containers, images and database contents prior to installing a clean copy of the hydroshare codebase as defined in the
rebuild_index: Rebuilds the solr/haystack index in a non-interactive way.
restart: Restarts the django server only (and nginx if applicable).
start: Starts all containers as defined in the
docker-compose.ymlfile (and nginx if applicable).
stop: Stops all containers as defined in the
update_index: Updates the solr/haystack index in a non-interactive way.
Testing and Debugging
Tests are run via normal Django tools and conventions. However, you should use the
hsctl script mentioned abouve with the
managepy command. For example:
./hsctl managepy test hs_core.tests.api.rest.test_resmap --keepdb.
There are currently over 600 tests in the system, so it is highly recommended that you run the test suites separately from one another.
You can debug via PyCharm by following the instructions here.
Other Configuration Options
Local iRODS is not required for development unless you are specifically working on the iRODS integration. However,if you want to work with iRODS or you simply want to learn about it, you can enable it locally.
To enable HTTPS locally:
config/hydroshare-config.templateand change the two values under
### Deployment Options ###to
### Deployment Options ### USE_NGINX: true USE_SSL: true
There are many ways to contribute to Hydroshare. Review Contributing guidelines and github practices for information on
- Opening issues for any bugs you find or suggestions you may have
- Developing code to contribute to HydroShare
- Developing a HydroShare App
- Submiting pull requests with code changes for review
Hydroshare is released under the BSD 3-Clause License. This means that you can do what you want, so long as you don't mess with the trademark, and as long as you keep the license with the source code.
©2017 CUAHSI. This material is based upon work supported by the National Science Foundation (NSF) under awards 1148453 and 1148090. Any opinions, findings, conclusions, or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the NSF.