Broker for Assimilation, Synthesis and Integration of eNvironmental Diverse, Distributed Datasets. A data synthesis framework for earth science data.
- basin3d uses the GitFlow model of branching and code versioning in git.
- Code development will be performed in a feature/development branch of the repo. Commits will not be made directly to the master branch of basin3d repo. Developers will submit a pull request that is then merged by another team member, if another team member is available.
- Each pull request should contain only related modifications to a feature or bug fix.
- Sensitive information (secret keys, usernames etc) and configuration data (e.g database host port) should not be checked into the repo.
- A practice of rebasing with the main repo should be used rather than merge commits.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
$ git clone git@github.com:BASIN-3D/basin3d.git
$ cd basin3d
Setup virtualenv for development and testing purposes. All basin3d tests
are in tests/.
Create an Anaconda environment
$ conda create -y -n basin3d python=3.7
Activate the new environment and prepare it for development
$ conda activate basin3d
$ conda develop -npf -n basin3d .
Install basin3d and its dependencies
$ pip install $(cat requirements.txt) pytest
$ pip install pytest-flake8 pytest-mypy pytest-cov sphinx PSphinxTheme
$ python setup.py develop
Run the tests (mypy and flake8 tests executed by default)
$ pytest
Run the tests with coverage
$ pytest --cov=basin3d
Run the tests with coverage ONLY
$ pytest --cov=basin3d tests
Sphinx is used to generate documentation. You first need to create a virtual environment for generating the docs.
$ conda activate basin3d
$ pip install -r docs/requirements.txt
Generate the documentation
$ cd docs
$ make html
Review the generated documentation
$ open _build/html/index.html
Install a source distribution with pip:
$ pip install basin3d-<version>.tar.gz
To get started read the setup documentation
We use SemVer for versioning. For the versions available, see the tags on this repository.
Workflow for tagging and building release:
- checkout the version to tag from
main $ git tag -a v[version]-[release] -m "Tagging release v[version]-[release]"- build distribution with
$ setup.py $ git push origin v[version]-[release]
Broker for Assimilation, Synthesis and Integration of eNvironmental Diverse, Distributed Datasets (BASIN-3D) Copyright (c) 2019, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.
If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Intellectual Property Office at IPO@lbl.gov.
NOTICE. This Software was developed under funding from the U.S. Department of Energy and the U.S. Government consequently retains certain rights. As such, the U.S. Government has been granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable, worldwide license in the Software to reproduce, distribute copies to the public, prepare derivative works, and perform publicly and display publicly, and to permit other to do so.
See LICENSE file for licensing details
This research is supported as part of the Watershed Function Scientific Focus Area funded by the U.S. Department of Energy, Office of Science, Office of Biological and Environmental Research under Award no. DE-AC02-05CH11231. This research used resources of the National Energy Research Scientific Computing Center (NERSC), U.S. Department of Energy Office of Science User Facility operated under Contract No. DE-AC02-05CH11231.