Skip to main content

Python package to easily access the CAMELS-AUS dataset

Project description

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:

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:

pip install camels_aus

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

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

Developers:

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

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..."

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

if: "Error displaying widget: model not found"

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

camels_aus-0.5.zip (16.9 kB view hashes)

Uploaded source

Built Distribution

camels_aus-0.5-py2.py3-none-any.whl (11.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page