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

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

Files for camels-aus, version 0.4
Filename, size File type Python version Upload date Hashes
Filename, size camels_aus-0.4-py2.py3-none-any.whl (27.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size camels_aus-0.4.zip (13.6 kB) File type Source Python version None Upload date Hashes View

Supported by

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