Package: yeoda
yeodaEarth Observation (EO) data, I must read.ContentsDescriptionInstallationPipCondaContributionCitationDescriptionyeodastands foryourearthobservationdataaccess and provides datacube classes
for reading and writing well-defined and structured earth observation data. These datacubes allow to filter, select, split, read and write data independently from the way the data is structured on disk.
Internally,yeodarelies on functionalities provided bygeopathfinder(filepath/filename and folder structure handling library),veranda(IO classes and higher-level data structure classes for vector and raster data)
andgeospade(raster and vector geometry/mosaic definitions and operations).For more details aboutyeoda's functionality and many use case examples, please check outyeoda's RTD documentation!InstallationThe package can be either installed via pip or if you solely want to work withyeodaor contribute, we recommend installing
it as a conda environment. If you work already with your own environment, please have look atconda_env.ymlorsetup.cfgfor the required dependencies.PipTo installyeodavia pip in your own environment, use:pip install yeodaATTENTION: Packages likegdal,cartopy, orgeopandasneed more OS support and have more dependencies than other packages and can therefore not be installed solely via pip.
Thus, for a fresh setup, an existing environment with the conda dependencies listed inconda_env.ymlis expected.
To create such an environment, you can run:conda create -n "yeoda" -c conda-forge python=3.8 mamba
conda activate yeoda
mamba install -c conda-forge python=3.8 gdal geopandas cartopyCondaThe packages also comes along with a pre-defined conda environment (conda_env.yml).
This is especially recommended if you want to contribute to the project.
The following script will install miniconda and setup the environment on a UNIX
like system. Miniconda will be installed into$HOME/miniconda.wget http://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
bash miniconda.sh -b -p $HOME/miniconda
export PATH="$HOME/miniconda/bin:$PATH"
mamba env create -f conda_env.yml
source activate yeodaThis script adds$HOME/miniconda/bintemporarily to thePATHto do this
permanently addexport PATH="$HOME/miniconda/bin:$PATH"to your.bashrcor.zshrc.For Windows, use the following setup:Download the latestminiconda 3 installerfor WindowsClick on.exefile and complete the installation.Add the foldercondabinfolder to your environment variablePATH.
You can find thecondabinfolder usually under:C:\Users\username\AppData\Local\Continuum\miniconda3\condabinFinally, you can set up the conda environment via:conda env create -f conda_env.yml
source activate yeodaAfter that you should be able to runpython setup.py testto run the test suite.ContributionWe 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.
If you want to contribute please follow these steps:Fork theyeodarepository to your accountClone theyeodarepositoryMake a new feature branch from theyeodamaster branchAdd your featurePlease include tests for your contributions in one of the test directories.
We usepy.testso a simple function calledtest_my_featureis enoughSubmit a pull request to our master branchCitationIf you use this 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 athttps://doi.org/10.5281/zenodo.3540693(link to first release) 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 athttp://help.zenodo.org/#versioning.