Capability to read instantaneous flow data

[vinfort]

Addressing a Problem?

Would be nice for xHydro to be able to read data from streamflow data providers.

Potential Solution

I am thus contributing code that can scrape the website of ECCC and CEHQ in order to obtain
all available instantaneous data for a given station.

Additional context

I suggest adding a files called getflowinst.py in src/xHydro, but the code could also be added in utils.py.

Contribution

I will be submitting a pull request with the code.

[vinfort]

Example of use for ECCC data:

In [1]: import getflowinst

In [2]: obj = getflowinst.GetFlow_ECCC(station='04CA002', path='testing/data')

In [3]: obj.get_data()
Searching for data on https://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/UnitValueData/Discharge/corrected/04
Found this file on ECCC server: Discharge.Working@04CA002.20110101_corrected.csv.xz
Downloading Discharge.Working@04CA002.20110101_corrected.csv.xz ... https://collaboration.cmc.ec.gc.ca/cmc/hydrometrics/www/UnitValueData/Discharge/corrected/04/Discharge.Working@04CA002.20110101_corrected.csv.xz
Done.
Processing Discharge.Working@04CA002.20110101_corrected.csv.xz ... Done.
Out[3]: 
<xarray.Dataset>
Dimensions:     (time: 715685)
Coordinates:
  * time        (time) object 1293858000000000000 ... 1761004500000000000
Data variables:
    Discharge   (time) float64 279.0 276.0 273.0 270.0 ... 259.1 259.1 259.3
    Approval    (time) object 'Approved' 'Approved' ... 'Preliminary'
    Grade       (time) int64 10 10 10 10 10 10 10 10 ... -1 -1 -1 -1 -1 -1 -1 -1
    Qualifiers  (time) object nan nan nan nan nan nan ... nan nan nan nan nan

[vinfort]

Example of use with CEHQ data:

In [1]: import getflowinst

In [2]: obj = getflowinst.GetFlow_CEHQ(station='073503', path='testing/data')

In [3]: obj.get_data()
Searching for data on https://www.cehq.gouv.qc.ca/hydrometrie/historique_donnees/fiche_instantanee.asp?NoStation=073503
Found these files on CEHQ server:
073503_Q_1997.txt
073503_Q_1998.txt
073503_Q_1999.txt
073503_Q_2000.txt
073503_Q_2001.txt
073503_Q_2002.txt
073503_Q_2003.txt
073503_Q_2004.txt
073503_Q_2005.txt
073503_Q_2006.txt
073503_Q_2007.txt
073503_Q_2008.txt
073503_Q_2009.txt
073503_Q_2010.txt
073503_Q_2011.txt
073503_Q_2012.txt
073503_Q_2013.txt
073503_Q_2014.txt
073503_Q_2015.txt
073503_Q_2016.txt
073503_Q_2017.txt
073503_Q_2018.txt
073503_Q_2019.txt
073503_Q_2020.txt
073503_Q_2021.txt
073503_Q_2022.txt
073503_Q_2023.txt
073503_Q_2024.txt
073503_Q_2025.txt
Downloading 073503_Q_1997.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_1997.txt
Done.
Processing 073503_Q_1997.txt ... Done.
Downloading 073503_Q_1998.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_1998.txt
Done.
Processing 073503_Q_1998.txt ... Done.
Downloading 073503_Q_1999.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_1999.txt
Done.
Processing 073503_Q_1999.txt ... Done.
Downloading 073503_Q_2000.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2000.txt
Done.
Processing 073503_Q_2000.txt ... Done.
Downloading 073503_Q_2001.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2001.txt
Done.
Processing 073503_Q_2001.txt ... Done.
Downloading 073503_Q_2002.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2002.txt
Done.
Processing 073503_Q_2002.txt ... Done.
Downloading 073503_Q_2003.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2003.txt
Done.
Processing 073503_Q_2003.txt ... Done.
Downloading 073503_Q_2004.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2004.txt
Done.
Processing 073503_Q_2004.txt ... Done.
Downloading 073503_Q_2005.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2005.txt
Done.
Processing 073503_Q_2005.txt ... Done.
Downloading 073503_Q_2006.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2006.txt
Done.
Processing 073503_Q_2006.txt ... Done.
Downloading 073503_Q_2007.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2007.txt
Done.
Processing 073503_Q_2007.txt ... Done.
Downloading 073503_Q_2008.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2008.txt
Done.
Processing 073503_Q_2008.txt ... Done.
Downloading 073503_Q_2009.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2009.txt
Done.
Processing 073503_Q_2009.txt ... Done.
Downloading 073503_Q_2010.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2010.txt
Done.
Processing 073503_Q_2010.txt ... Done.
Downloading 073503_Q_2011.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2011.txt
Done.
Processing 073503_Q_2011.txt ... Done.
Downloading 073503_Q_2012.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2012.txt
Done.
Processing 073503_Q_2012.txt ... Done.
Downloading 073503_Q_2013.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2013.txt
Done.
Processing 073503_Q_2013.txt ... Done.
Downloading 073503_Q_2014.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2014.txt
Done.
Processing 073503_Q_2014.txt ... Done.
Downloading 073503_Q_2015.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2015.txt
Done.
Processing 073503_Q_2015.txt ... Done.
Downloading 073503_Q_2016.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2016.txt
Done.
Processing 073503_Q_2016.txt ... Done.
Downloading 073503_Q_2017.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2017.txt
Done.
Processing 073503_Q_2017.txt ... Done.
Downloading 073503_Q_2018.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2018.txt
Done.
Processing 073503_Q_2018.txt ... Done.
Downloading 073503_Q_2019.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2019.txt
Done.
Processing 073503_Q_2019.txt ... Done.
Downloading 073503_Q_2020.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2020.txt
Done.
Processing 073503_Q_2020.txt ... Done.
Downloading 073503_Q_2021.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2021.txt
Done.
Processing 073503_Q_2021.txt ... Done.
Downloading 073503_Q_2022.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2022.txt
Done.
Processing 073503_Q_2022.txt ... Done.
Downloading 073503_Q_2023.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2023.txt
Done.
Processing 073503_Q_2023.txt ... Done.
Downloading 073503_Q_2024.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2024.txt
Done.
Processing 073503_Q_2024.txt ... Done.
Downloading 073503_Q_2025.txt ... https://www.cehq.gouv.qc.ca/depot/historique_donnees_instantanees/073503_Q_2025.txt
Done.
Processing 073503_Q_2025.txt ... Done.
Out[3]: 
<xarray.Dataset>
Dimensions:     (time: 988475)
Coordinates:
  * time        (time) object 875682000000000000 ... 1765308600000000000
Data variables:
    Discharge   (time) float64 185.0 nan nan nan 185.9 ... 73.61 73.61 nan nan
    Qualifiers  (time) object nan 'A' 'A' 'A' nan 'A' ... nan nan nan 'A' 'A'