Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/csiro-hydroinformatics/camels-aus-py

Python package to easily load and use the CAMELS-AUS dataset

https://github.com/csiro-hydroinformatics/camels-aus-py

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ○
    codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.5%) to scientific vocabulary

Keywords

camels-dataset hydrology
Last synced: 11 months ago · JSON representation

Repository

Python package to easily load and use the CAMELS-AUS dataset

Basic Info
  • Host: GitHub
  • Owner: csiro-hydroinformatics
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 973 KB
Statistics
  • Stars: 5
  • Watchers: 1
  • Forks: 2
  • Open Issues: 0
  • Releases: 0
Topics
camels-dataset hydrology
Created over 5 years ago · Last pushed over 4 years ago
Metadata Files
Readme Contributing License

README.md

CAMELS-AUS from python

license status

This is currently a preview. You can contribute to features and design

Python package to easily load and use the CAMELS-AUS dataset (Fowler, K. J. A. et al. 2020 (in review))

CAMELS-AUS is the Australian edition of the Catchment Attributes and Meteorology for Large-sample Studies.

Loading CAMELS-AUS from a notebook

Release notes

  • v0.5: support loading more series and catchment attributes.
  • v0.4: load minimal series for typical rainfall-runoff modelling

License

BSD-3 (see License)

Source code

The code repository is on GitHub.

Installation

Linux

Using a conda environment is recommended. To create a new environment:

bash cd ${HOME}/tmp wget https://raw.githubusercontent.com/csiro-hydroinformatics/camels-aus-py/main/configs/camels_aus_environment.yml my_env_name=camels conda env create -n $my_env_name -f ./camels_aus_environment.yml conda activate $my_env_name

Then:

sh pip install camels_aus

If installing from source, after checking out this git repo:

sh pip install -r requirements.txt # if not using conda python setup.py install

Developers:

sh python setup.py develop

optional: setting jupyter-lab

optional but recommended: use mamba as a replacement for conda: conda install -c conda-forge --name ${my_env_name} mamba

sh mamba install -c conda-forge jupyterlab ipywidgets jupyter ipyleaflet python -m ipykernel install --user --name ${my_env_name} --display-name "CAMELS" jupyter-lab .

Troubleshooting

Notebooks

Normally jupyter-lab version 3.0 and more does not require explicit extensions installation, but if you have issues:

if: "Loading widgets..."

sh jupyter-labextension install @jupyter-widgets/jupyterlab-manager

if: "Error displaying widget: model not found"

sh jupyter-labextension install @jupyter-widgets/jupyterlab-manager

Owner

  • Name: CSIRO Hydroinformatics
  • Login: csiro-hydroinformatics
  • Kind: organization

CSIRO - hydroinformatics repositories

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 18
  • Total Committers: 1
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
J-M j****d@c****u 18
Committer Domains (Top 20 + Academic)
csiro.au: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 29 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 3
  • Total maintainers: 1
pypi.org: camels-aus

Python package to easily access the CAMELS-AUS dataset

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 29 Last month
Rankings
Dependent packages count: 7.4%
Forks count: 19.2%
Dependent repos count: 22.2%
Average: 24.2%
Stargazers count: 25.1%
Downloads: 47.1%
Maintainers (1)
jmp_oz
Last synced: 12 months ago

Dependencies

docs/environment.yml conda
  • geopandas
  • mkdocs
  • mkdocs-material
  • mkdocs-material-extensions
  • mkdocstrings
  • pandas
  • scipy
  • xarray
docs/requirements.txt pypi
  • geopandas *
  • mkdocs *
  • mkdocs-jupyter *
  • mkdocs-material *
  • mkdocs-material-extensions *
  • mkdocstrings *
  • mock *
  • pandas *
  • pillow *
  • recommonmark *
  • scipy *
  • six *
  • xarray *
requirements.txt pypi
  • geopandas *
  • numpy *
  • pandas *
  • scipy *
  • xarray *