Metadata-Version: 2.1
Name: camels-aus
Version: 0.4
Summary: Python package to easily access the CAMELS-AUS dataset
Home-page: https://github.com/csiro-hydroinformatics/camels-aus-py
Author: Jean-Michel Perraud
Author-email: per202@csiro.au
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/csiro-hydroinformatics/camels-aus-py/issues
Project-URL: Source, https://github.com/csiro-hydroinformatics/camels-aus-py
Description: # CAMELS-AUS from python
        
        [![license](https://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/csiro-hydroinformatics/camels-aus-py/blob/master/LICENSE) ![status](https://img.shields.io/badge/status-alpha-orange.svg) 
        
        _This is currently a preview. You can contribute to features and design_
        
        <!-- master: [![Build status - master](https://ci.appveyor.com/api/projects/status/vmwq7xarxxj8s564/branch/master?svg=true)](https://ci.appveyor.com/project/jmp75/camels-aus-py/branch/master) testing: [![Build status - devel](https://ci.appveyor.com/api/projects/status/vmwq7xarxxj8s564/branch/testing?svg=true)](https://ci.appveyor.com/project/jmp75/camels-aus-py/branch/testing) -->
        
        **Python package to easily load and use the CAMELS-AUS dataset ([Fowler, K. J. A. et al. 2020 (in review)](https://doi.org/10.5194/essd-2020-228))**
        
        CAMELS-AUS is the Australian edition of the Catchment Attributes and Meteorology for Large-sample Studies.
        
        ![Loading CAMELS-AUS from a notebook](./docs/img/rapid_camels_load.png "Loading CAMELS-AUS from a notebook")
        
        ## License
        
        BSD-3 (see [License](https://github.com/csiro-hydroinformatics/camels-aus-py/blob/master/LICENSE))
        
        ## Source code
        
        The code repository is on [GitHub](https://github.com/csiro-hydroinformatics/camels-aus-py).
        
        ## 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
        onda 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
        ```
        
        
Keywords: earth-sciences hydrology forecast
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Hydrology
Classifier: Topic :: Database
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
