dasf-messaging-typescript/README.md

Typescript RPC bindings for the data analytics software framework (DASF)

![DASF Logo](https://git.geomar.de/digital-earth/dasf/dasf-messaging-python/-/raw/master/docs/_static/dasf_logo.svg)

[![DOI](https://git.geomar.de/digital-earth/dasf/dasf-messaging-typescript/-/raw/master/doi_badge.svg)](https://doi.org/10.5880/GFZ.1.4.2021.008)
[![npm version](https://badge.fury.io/js/dasf-messaging-typescript.svg)](https://badge.fury.io/js/dasf-messaging-typescript)
[![status](https://joss.theoj.org/papers/e8022c832c1bb6e879b89508a83fa75e/status.svg)](https://joss.theoj.org/papers/e8022c832c1bb6e879b89508a83fa75e)

## dasf-messaging-typescript

`dasf-messaging-typescript` is part of the Data Analytics Software Framework (DASF, https://git.geomar.de/digital-earth/dasf), 
developed at the GFZ German Research Centre for Geosciences (https://www.gfz-potsdam.de). 
It is funded by the Initiative and Networking Fund of the Helmholtz Association through the Digital Earth project 
(https://www.digitalearth-hgf.de/).

`dasf-messaging-typescript` provides the typescript bindings for the DASF RPC messaging protocol and therefore allows to connect to any algorithm or method (e.g. via the `dasf-messaging-python` implementation). Because of the component based architecture the integrated method could be deployed anywhere (e.g. close to the data it is processing). You may use `dasf-web` for interactive data visualizations.


### Service Desk

For everyone without a Geomar Gitlab account, we setup the Service Desk feature for this repository.
It lets you communicate with the developers via a repository specific eMail address. Each request will be tracked via the Gitlab issuse tracker.

eMail: [gitlab+digital-earth-dasf-dasf-web-1982-issue-@git-issues.geomar.de](mailto:gitlab+digital-earth-dasf-dasf-web-1982-issue-@git-issues.geomar.de)


### NPM Package `dasf-messaging-typescript`
[![npm version](https://badge.fury.io/js/dasf-messaging-typescript.svg)](https://badge.fury.io/js/dasf-typescript)

You may install it (and save it to your `package.json`) via:

```bash
npm install dasf-messaging-typescript --save
```

### Usage

https://git.geomar.de/digital-earth/dasf/dasf-full-example

or

https://git.geomar.de/digital-earth/dasf/dasf-app-template

### Documentation

see https://digital-earth.pages.geomar.de/dasf/dasf-messaging-python/

### Recommended Software Citation

`Eggert, Daniel; Sips, Mike; Sommer, Philipp S.; Dransch, Doris (2022): DASF: A data analytics software framework for distributed environments. GFZ Data Services. https://doi.org/10.5880/GFZ.1.4.2021.008`

### License
```
Copyright 2022 Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences, Potsdam, Germany / DASF Data Analytics Software Framework

Licensed under the Apache License, Version 2.0 (the "License");
you may not use these files except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

### Contact
Dr.-Ing. Daniel Eggert  
eMail: <daniel.eggert@gfz-potsdam.de>


Helmholtz Centre Potsdam GFZ German Research Centre for Geoscienes  
Section 1.4 Remote Sensing & Geoinformatics  
Telegrafenberg  
14473 Potsdam  
Germany