Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstring #11

Merged
merged 2 commits into from
Feb 10, 2021
Merged

Add docstring #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2af80ac
Merge pull request #10 from fundacaocerti/develop
fcs-certi Dec 11, 2020
bc9e136
Add docstring
fcs-certi Feb 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion qda_modelos/reservoir_water_quality_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# ##################################################################################################
"""
This module implements the Reservoir Water Quality Index as
presented by the Institudo Ambiental do Paraná, described in
presented by the Instituto Ambiental do Paraná, described in
http://pnqa.ana.gov.br/indicadores-qualidade-agua.aspx.
"""

Expand Down
7 changes: 7 additions & 0 deletions qda_modelos/trophic_state_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@

def lamparelli_2004(chlorophylla, phosphorus):

"""
Before using the qda_modelos Trophic State Index method in your code,
it's necessary to multiply the phosphorus value by 1000.
Once phosphorus is commonly considered in mg/L,
but for this specific indicator it's considered in mg/m³.
"""

trophic_state_index_chl = 10 * (6 - ((0.92 - 0.34 * numpy.log(chlorophylla)) / numpy.log(2)))
trophic_state_index_pho = 10 * (6 - (1.77 - 0.42 * (numpy.log(phosphorus) / numpy.log(2))))

Expand Down