-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove these for PR, deploying from static for now
- Loading branch information
Showing
63 changed files
with
21,740 additions
and
0 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
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,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 693fe2c048d6bd7dc732262032b394aa | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
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,44 @@ | ||
.. _contributing: | ||
|
||
Contributing to harmonize_wq | ||
============================ | ||
harmonize_wq uses: | ||
|
||
- `github <https://github.com/USEPA/harmonize-wq>`_ to host the code. | ||
- `github actions <https://docs.github.com/en/actions>`_ to test all commits and PRs. | ||
- `pytest <https://docs.pytest.org/en/stable/>`_ to write tests. | ||
- `sphinx <https://www.sphinx-doc.org/en/master/>`_ to write docs. | ||
|
||
You can contribute in different ways: | ||
|
||
Report issues | ||
------------- | ||
|
||
You can report any issues with the package, the documentation to the `issue tracker`_. | ||
Also feel free to submit feature requests, comments or questions. | ||
|
||
|
||
Contribute code | ||
--------------- | ||
|
||
To contribute fixes, code or documentation, fork harmonize_wq in github_ and submit | ||
the changes using a pull request against the **main** branch. | ||
|
||
- If you are submitting new code, add tests (see below) and documentation. | ||
- Write "Closes #<bug number>" in the PR description or a comment, as described in the | ||
`github docs`_. | ||
- Check tests and resolve any issues. | ||
|
||
In any case, feel free to use the `issue tracker`_ to discuss ideas for new features or improvements. | ||
|
||
Notice that we will not merge a PR if tests are failing. In certain cases tests pass in your | ||
machine but not in github actions. There might be multiple reasons for this but these are some of | ||
the most common | ||
|
||
- Your new code does not work for other operating systems or Python versions. | ||
- The documentation is not being built properly or the examples in the docs are | ||
not working. | ||
|
||
|
||
.. _`issue tracker`: https://github.com/USEPA/harmonize-wq/issues | ||
.. _`github docs`: https://help.github.com/articles/closing-issues-via-commit-messages/ |
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,77 @@ | ||
harmonize\_wq package | ||
===================== | ||
|
||
Submodules | ||
---------- | ||
|
||
harmonize\_wq.basis module | ||
-------------------------- | ||
|
||
.. automodule:: harmonize_wq.basis | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.clean module | ||
-------------------------- | ||
|
||
.. automodule:: harmonize_wq.clean | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.convert module | ||
---------------------------- | ||
|
||
.. automodule:: harmonize_wq.convert | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.domains module | ||
---------------------------- | ||
|
||
.. automodule:: harmonize_wq.domains | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.harmonize module | ||
------------------------------ | ||
|
||
.. automodule:: harmonize_wq.harmonize | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.location module | ||
----------------------------- | ||
|
||
.. automodule:: harmonize_wq.location | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.visualize module | ||
------------------------------ | ||
|
||
.. automodule:: harmonize_wq.visualize | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
harmonize\_wq.wrangle module | ||
---------------------------- | ||
|
||
.. automodule:: harmonize_wq.wrangle | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: | ||
|
||
Module contents | ||
--------------- | ||
|
||
.. automodule:: harmonize_wq | ||
:members: | ||
:undoc-members: | ||
:show-inheritance: |
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,43 @@ | ||
.. harmonize_wq documentation master file, created by | ||
sphinx-quickstart on Mon Jul 3 14:48:49 2023. | ||
You can adapt this file completely to your liking, but it should at least | ||
contain the root `toctree` directive. | ||
harmonize_wq: | ||
============= | ||
Standardize, clean and wrangle Water Quality Portal data into more analytic-ready formats | ||
----------------------------------------------------------------------------------------- | ||
**Useful links**: | ||
`Code Repository <https://github.com/USEPA/harmonize-wq>`__ | | ||
`Issues <https://github.com/USEPA/harmonize-wq/issues>`__ | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Getting Started | ||
|
||
overview | ||
installing | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:caption: Reference Documentation | ||
|
||
modules | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:hidden: | ||
:caption: Development | ||
|
||
contributing | ||
|
||
Indices and tables | ||
------------------ | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` | ||
|
||
Disclaimer | ||
========== | ||
The United States Environmental Protection Agency (EPA) GitHub project code is provided on an “as is” basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government. |
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,10 @@ | ||
.. _installing: | ||
|
||
Installing harmonize_wq | ||
======================= | ||
|
||
harmonize_wq can be installed from git using pip: | ||
|
||
.. code-block:: python3 | ||
pip install git+https://github.com/USEPA/harmonize-wq.git |
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,7 @@ | ||
harmonize_wq | ||
============ | ||
|
||
.. toctree:: | ||
:maxdepth: 4 | ||
|
||
harmonize_wq |
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,15 @@ | ||
.. _overview: | ||
|
||
Overview | ||
======== | ||
|
||
US EPA’s `Water Quality Portal (WQP) <https://www.waterqualitydata.us/>`_ aggregates water quality, biological, and physical data provided by many organizations and has become an essential resource with tools to query and retrieval data using `python <https://github.com/USGS-python/dataretrieval>`_ or `R <https://github.com/USGS-R/dataRetrieval>`_. Given the variety of data and variety of data originators, using the data in analysis often requires data cleaning to ensure it meets the required quality standards and data wrangling to get it in a more analytic-ready format. Recognizing the definition of analysis-ready varies depending on the analysis, the harmonixe_wq package is intended to be a flexible water quality specific framework to help: | ||
|
||
* Identify differences in data units (including speciation and basis) | ||
* Identify differences in sampling or analytic methods | ||
* Resolve data errors using transparent assumptions | ||
* Transform data from long to wide format | ||
|
||
Domain experts must decide what data meets their quality standards for data comparability and any thresholds for acceptance or rejection. | ||
|
||
For more complete tutorial information, see: `demos <https://github.com/USEPA/harmonize-wq/tree/main/demos>`_ |
134 changes: 134 additions & 0 deletions
134
docs/build/html/_static/_sphinx_javascript_frameworks_compat.js
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,134 @@ | ||
/* | ||
* _sphinx_javascript_frameworks_compat.js | ||
* ~~~~~~~~~~ | ||
* | ||
* Compatability shim for jQuery and underscores.js. | ||
* | ||
* WILL BE REMOVED IN Sphinx 6.0 | ||
* xref RemovedInSphinx60Warning | ||
* | ||
*/ | ||
|
||
/** | ||
* select a different prefix for underscore | ||
*/ | ||
$u = _.noConflict(); | ||
|
||
|
||
/** | ||
* small helper function to urldecode strings | ||
* | ||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL | ||
*/ | ||
jQuery.urldecode = function(x) { | ||
if (!x) { | ||
return x | ||
} | ||
return decodeURIComponent(x.replace(/\+/g, ' ')); | ||
}; | ||
|
||
/** | ||
* small helper function to urlencode strings | ||
*/ | ||
jQuery.urlencode = encodeURIComponent; | ||
|
||
/** | ||
* This function returns the parsed url parameters of the | ||
* current request. Multiple values per key are supported, | ||
* it will always return arrays of strings for the value parts. | ||
*/ | ||
jQuery.getQueryParameters = function(s) { | ||
if (typeof s === 'undefined') | ||
s = document.location.search; | ||
var parts = s.substr(s.indexOf('?') + 1).split('&'); | ||
var result = {}; | ||
for (var i = 0; i < parts.length; i++) { | ||
var tmp = parts[i].split('=', 2); | ||
var key = jQuery.urldecode(tmp[0]); | ||
var value = jQuery.urldecode(tmp[1]); | ||
if (key in result) | ||
result[key].push(value); | ||
else | ||
result[key] = [value]; | ||
} | ||
return result; | ||
}; | ||
|
||
/** | ||
* highlight a given string on a jquery object by wrapping it in | ||
* span elements with the given class name. | ||
*/ | ||
jQuery.fn.highlightText = function(text, className) { | ||
function highlight(node, addItems) { | ||
if (node.nodeType === 3) { | ||
var val = node.nodeValue; | ||
var pos = val.toLowerCase().indexOf(text); | ||
if (pos >= 0 && | ||
!jQuery(node.parentNode).hasClass(className) && | ||
!jQuery(node.parentNode).hasClass("nohighlight")) { | ||
var span; | ||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); | ||
if (isInSVG) { | ||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); | ||
} else { | ||
span = document.createElement("span"); | ||
span.className = className; | ||
} | ||
span.appendChild(document.createTextNode(val.substr(pos, text.length))); | ||
node.parentNode.insertBefore(span, node.parentNode.insertBefore( | ||
document.createTextNode(val.substr(pos + text.length)), | ||
node.nextSibling)); | ||
node.nodeValue = val.substr(0, pos); | ||
if (isInSVG) { | ||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); | ||
var bbox = node.parentElement.getBBox(); | ||
rect.x.baseVal.value = bbox.x; | ||
rect.y.baseVal.value = bbox.y; | ||
rect.width.baseVal.value = bbox.width; | ||
rect.height.baseVal.value = bbox.height; | ||
rect.setAttribute('class', className); | ||
addItems.push({ | ||
"parent": node.parentNode, | ||
"target": rect}); | ||
} | ||
} | ||
} | ||
else if (!jQuery(node).is("button, select, textarea")) { | ||
jQuery.each(node.childNodes, function() { | ||
highlight(this, addItems); | ||
}); | ||
} | ||
} | ||
var addItems = []; | ||
var result = this.each(function() { | ||
highlight(this, addItems); | ||
}); | ||
for (var i = 0; i < addItems.length; ++i) { | ||
jQuery(addItems[i].parent).before(addItems[i].target); | ||
} | ||
return result; | ||
}; | ||
|
||
/* | ||
* backward compatibility for jQuery.browser | ||
* This will be supported until firefox bug is fixed. | ||
*/ | ||
if (!jQuery.browser) { | ||
jQuery.uaMatch = function(ua) { | ||
ua = ua.toLowerCase(); | ||
|
||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || | ||
/(webkit)[ \/]([\w.]+)/.exec(ua) || | ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || | ||
/(msie) ([\w.]+)/.exec(ua) || | ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || | ||
[]; | ||
|
||
return { | ||
browser: match[ 1 ] || "", | ||
version: match[ 2 ] || "0" | ||
}; | ||
}; | ||
jQuery.browser = {}; | ||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; | ||
} |
Oops, something went wrong.