-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor project README.md structure and Sphinx documentation
Adds changelog to README and Sphinx documentation. Adds contributing to README, edits install instructions. Adds copyright and license to documentation. Renames api.rst and models.rst files. Changes basin3d-core to basin3d reference in documentation. Changes setup.py. Moves items around in table of contents. Closes #36
- Loading branch information
Cat
committed
Apr 2, 2021
1 parent
fa785a2
commit 569ad66
Showing
13 changed files
with
234 additions
and
123 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Changelog | ||
|
||
## Version 0.0.2 | ||
Project Updates: | ||
+ Enable Github Actions | ||
+ Temporarily freeze Pandas v1.1.5 due to NaN errors | ||
+ Handle empty data returns | ||
|
||
Install Updates: | ||
+ Issue #29, #7: Fix install commands | ||
|
||
Documentation Updates: | ||
+ Issue #26: Fix typos and errors in README | ||
+ Issue #27, 35: Fix basin3d reference and updates authors | ||
+ Issue #28: Update git clone link in README | ||
+ Issue #38: Add BASIN-3D concepts to documentation | ||
+ Issue #41: Fix autogenerated Sphinx documentation | ||
+ Remove prerequisites section in README | ||
+ Update license to the BASIN-3D license | ||
|
||
## Version 0.0.1 | ||
Project Updates: | ||
+ Prepare version for open-source release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,83 @@ | ||
## How to contribute to basin3d | ||
|
||
* Steps for creating good issues or pull requests. | ||
* Links to external documentation, mailing lists, or a code of conduct. | ||
* Community and behavioral expectations. | ||
## Quick Links | ||
* [Documentation]() | ||
* [Issue Template: Bugs](.github/ISSUE_TEMPLATE/bug_report.md) | ||
* [Issue Template: New Feature](.github/ISSUE_TEMPLATE/feature_request.md) | ||
* [Pull Request Template](.github/pull_request_template.md) | ||
* [Code of Conduct](CODE_OF_CONDUCT.md) | ||
|
||
|
||
## Development Practices | ||
|
||
* basin3d uses the [GitFlow model](https://datasift.github.io/gitflow/IntroducingGitFlow.html) | ||
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. | ||
|
||
## Develop | ||
|
||
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 | ||
|
||
|
||
## Documentation | ||
|
||
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 | ||
|
||
|
||
## Versioning | ||
|
||
We use [SemVer](http://semver.org/) for versioning. For the versions available, | ||
see the [tags on this repository](https://github.com/BASIN-3D/basin3d/tags). | ||
|
||
Workflow for tagging and building release: | ||
|
||
1. checkout the version to tag from `main` | ||
1. `$ git tag -a v[version]-[release] -m "Tagging release v[version]-[release]"` | ||
1. build distribution with `$ setup.py` | ||
1. `$ git push origin v[version]-[release]` | ||
|
||
## Questions | ||
Our preferred channels of communication are public. Please open a [new discussion topic](https://github.com/BASIN-3D/basin3d/discussions) on Github discussions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,26 @@ | ||
Change Log | ||
********** | ||
********** | ||
|
||
Version 0.0.2 | ||
############## | ||
Project Updates: | ||
+ Enable Github Actions | ||
+ Temporarily freeze Pandas v1.1.5 due to NaN errors | ||
+ Handle empty data returns | ||
|
||
Install Updates: | ||
+ Issue #29, #7: Fix install commands | ||
|
||
Documentation Updates: | ||
+ Issue #26: Fix typos and errors in README | ||
+ Issue #27, 35: Fix basin3d reference and updates authors | ||
+ Issue #28: Update git clone link in README | ||
+ Issue #38: Add BASIN-3D concepts to documentation | ||
+ Issue #41: Fix autogenerated Sphinx documentation | ||
+ Remove prerequisites section in README | ||
+ Update license to the BASIN-3D license | ||
|
||
Version 0.0.1 | ||
############### | ||
Project Updates: | ||
+ Prepare version for open-source release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,9 @@ | ||
Copyright Notice | ||
**************** | ||
**************** | ||
|
||
|
||
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. |
Oops, something went wrong.