camels-aus 0.3

Python package to easily access the CAMELS-AUS dataset

CAMELS-AUS python

This is currently a preview; get involved if you wish to influence the features and design.

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

License

BSD-3 (see License)

Source code

The code repository is on GitHub.

Installation

TODO: Docker

Linux

Using a conda environment is recommended.

# TODO wget or curl for camels_aus_environment.yml
cm_src=${HOME}/src/github/camels-aus-py
my_env_name=camels
cd ${cm_src}
conda env create -n $my_env_name -f ./configs/camels_aus_environment.yml
conda activate $my_env_name 

pip install camels_aus

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 .

pip install -r requirements.txt

From source:

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

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