OPENSENSE software sandbox

A collection of software packages for processing data from opportunistic rainfall sensors, developed within the COST Action OPENSENSE

This is currently WIP and just a showcase of how existing codebases and existing open datasets can be combined in a reproducible environment and run online via mybinder.

Run code online

Even though this repo is WIP, feel free to try out the preliminary notebooks by clicking on the button "lauch binder" above. Note that it can take some minutes to build the online environment in case mybinder has no cached version of it.

Run environment locally

To run the code locally and/or to contribute to this repository, you need to set up the conda environment defined in the file environment.yml which is also used by mybinder to build the environment that you run online.

First, you need to have conda installed. If this is you first installation of conda we recommend to start with the mambaforge installer which is available for Windows, Linux and Mac here. Note that "mamba" is just a faster implementation of "conda", and "forge" refers to the fact that you will use the community packages from the conda-forge "channel", which has a larger choice of scientific Python and R packages than the default conda "channel".

With conda set up, follow these steps:

1. Clone this repo and its git submodules to your machine. Or, if you plan to contribute, first create a fork of it and clone from this fork (you have to adjust the URL below). Note that git clone will create a new directory OPENSENSE_sandbox in the directory that you are currently in and place the repo content there.

   git clone --recursive https://github.com/OpenSenseAction/OPENSENSE_sandbox.git
   

2. Go to this directory and create the conda environment. Note that you have to be in a terminal/shell where conda is available. Please refer to the conda docs to find out how to achieve that.

   conda env create environment.yml
   

3. Activate the env.

   conda activate opensense_sandbox
   

4. Install jupyter-lab in addition. It is not in then environment.yml because mybinder installs it by default.

   conda install jupyter-lab
   

5. Run jupyter-lab. It will open in your default browser.

   jupyter-lab
   

Contributing

We encourages everyone to contribute to the developement of the OPENSENSE_sandbox.

The easiest way is to fork the repository and submit a pull request (PR). Each PR automatically gets its own mybinder button to test everything in its defined environment. PRs will be iterated with and merged by the repository maintainers. If required we can also have dev branches in this repository.

Note that, if you have to change the dependencies, you can update your local conda env based on an updated environment.yml file like this (see here)

conda activate myenv
conda env update --file environment.yml --prune

Code of Conduct

Contributors to the OPENSENSE_sandbox are expected to act respectfully toward others in accordance with the OSGeo Code of Conduct.

Contributions and Licensing

All contributions shall comply to the project license. The individual included packages might have their own license, which has to be compatible with the one of the project license.