Add a short description here!
If you use the software in a publication then please cite it using the Zenodo DOI. Be aware that this badge links to the latest package version.
Please select your specific version at https://doi.org/10.5281/zenodo.846761 to get the DOI of that version. You should normally always use the DOI for the specific version of your record in citations. This is to ensure that other researchers can access the exact research artefact you used for reproducibility.
You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning
This package should be installable through pip:
pip install pygeobase
Its only dependecy is numpy. But to use it effectively you will also probably want to install pygeogrids.
We are happy if you want to contribute. Please raise an issue explaining what is missing or if you find a bug. We will also gladly accept pull requests against our master branch for new features or bug fixes.
For Development we recommend a conda environment. You can create one including test dependencies and debugger by running conda env create -f conda_requirements.yml. This will create a new pygeobase_env environment which you can activate by using source activate pygeobase_env.
Example installation script
The following script will install miniconda and setup the environment on a UNIX like system. Miniconda will be installed into $HOME/miniconda.
wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh bash miniconda.sh -b -p $HOME/miniconda export PATH="$HOME/miniconda/bin:$PATH" git clone email@example.com:TUW-GEO/pygeobase.git pygeobase cd pygeobase conda env create -f conda_environment.yml source activate pygeobase_env
This script adds $HOME/miniconda/bin temporarily to the PATH to do this permanently add export PATH="$HOME/miniconda/bin:$PATH" to your .bashrc or .zshrc
The last line in the example activates the pygeobase_env environment.
After that you should be able to run:
python setup.py test
to run the test suite.
If you want to contribute please follow these steps:
- Fork the pygeobase repository to your account
- Clone the repository
- make a new feature branch from the pygeobase master branch
- Add your feature
- Please include tests for your contributions in one of the test directories. We use py.test so a simple function called test_my_feature is enough
- submit a pull request to our master branch
This project has been set up using PyScaffold 3.2.3. For details and usage information on PyScaffold see https://pyscaffold.org/.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.