Data

Tools

Indexes

Applications

Experiments

Open Source Science

opensense_sandbox

Collection of runable examples with software packages for processing opportunistic rainfall sensors

https://github.com/opensenseaction/opensense_sandbox

Science Score: 46.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 5 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 11 committers (18.2%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Collection of runable examples with software packages for processing opportunistic rainfall sensors

Basic Info
  • Host: GitHub
  • Owner: OpenSenseAction
  • License: bsd-3-clause
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 11.3 MB
Statistics
  • Stars: 15
  • Watchers: 3
  • Forks: 16
  • Open Issues: 15
  • Releases: 1
Created about 4 years ago · Last pushed over 1 year ago
Metadata Files
Readme License

README.md

drawing

DOI

Binder :point_left: Click here to run the examples online. Please retry if the build process does not finish after some minutes.

One of the examples will walk you through a full CML processing from raw data provided by the OpenMRG dataset to a rainfall map animation like this one:

drawing

OPENSENSE software sandbox

The OPENSENSE software sandbox is a collection of software packages for processing data from opportunistic rainfall sensors, developed within the COST Action OPENSENSE.

The purpose of this repo is to showcase existing codebases and existing open datasets in one reproducible environment that can be run online via mybinder.

Not all notebooks are in a final state, but the OpenMRG usecase and data exploration notebooks are nicely prepared to give new users a quick overview of code and data that is available.

Run code online

This repository is inteded to be run online via the "launch binder" button above. Note that it can take some minutes to spin up the online environment. In some cases it might not start at all due to limited resources of the binder service. In that case, just try again some minutes later.

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 (located in the seperated environment repository) 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 or mamba 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 OPENSENSEsandbox in the directory that you are currently in and place the repo content there. ``` git clone --recursive https://github.com/OpenSenseAction/OPENSENSEsandbox.git 2. Stay in the directory of step 1, or change to it if required. Then download the `environment.yml` file from the [seperated environment repository](https://github.com/OpenSenseAction/OPENSENSE_sandbox_environment) via `wget` like this wget https://raw.githubusercontent.com/OpenSenseAction/OPENSENSEsandboxenvironment/main/environment.yml or via `curl` curl -O https://raw.githubusercontent.com/OpenSenseAction/OPENSENSEsandboxenvironment/main/environment.yml If neither `wget` nor `curl` are available, you can also download the environment file via the browser, but make sure to save it in the directory to which you cloned the sandbox repo in step 1. 3. Create the `conda` environment. Note that you have to be in a terminal/shell where `conda` or `mamba` is available. Please refer to the `conda` docs to find out how to achieve that. mamba env create environment.yml 4. Activate the env. conda activate opensense_sandbox 5. Install `jupyter-lab` in addition. It is not in then `environment.yml` because mybinder installs it by default. mamba install -c conda-forge jupyterlab 6. Run `jupyter-lab`. It will open in your default browser. jupyter-lab `` 7. Go to the index notebook innotebooks/index.ipynb` and run the cell with the init script, using the line of code for local installation which is commented out by default. This will clone the code of the submodules, add them to the conda env and install the R packages.

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.

Owner

  • Name: OpenSenseAction
  • Login: OpenSenseAction
  • Kind: organization

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 46
  • Total Committers: 11
  • Avg Commits per committer: 4.182
  • Development Distribution Score (DDS): 0.435
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Christian Chwala c****a@k****u 26
Max Graf 4****f 6
eoydvin e****n@g****m 4
Hai Victor Habi h****h@m****l 3
overeem11 o****m@k****l 1
Nico Blettner 7****r 1
Martin Fencl m****l@c****z 1
LottedeVos 2****s 1
JochenSeidel 1****l 1
G. Schutz 9****z 1
Abbas El Hachem 2****m 1
Committer Domains (Top 20 + Academic)
cvut.cz: 1 knmi.nl: 1 mail.tau.ac.il: 1 kit.edu: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 32
  • Total pull requests: 39
  • Average time to close issues: 2 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 6
  • Total pull request authors: 11
  • Average comments per issue: 2.31
  • Average comments per pull request: 4.15
  • Merged pull requests: 30
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • cchwala (24)
  • georges-schutz (2)
  • overeem11 (2)
  • maxmargraf (1)
  • fenclmar (1)
  • RemcoBeek (1)
Pull Request Authors
  • cchwala (17)
  • maxmargraf (5)
  • JochenSeidel (4)
  • eoydvin (4)
  • haihabi (3)
  • overeem11 (3)
  • georges-schutz (2)
  • nblettner (1)
  • LottedeVos (1)
  • fenclmar (1)
  • AbbasElHachem (1)
Top Labels
Issue Labels
user experience (11) Python code (7) data (7) high priority (7) build_process (6) R code (4) bug (3) visualization (2) enhancement (1) documentation (1)
Pull Request Labels
bug (1) high priority (1) Python code (1) data (1)

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 2
proxy.golang.org: github.com/opensenseaction/opensense_sandbox
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago
proxy.golang.org: github.com/OpenSenseAction/OPENSENSE_sandbox
  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 10 months ago

Dependencies

.github/workflows/binder-badge.yaml actions
  • actions/github-script v3 composite