/osdg

A tool to assign Sustainable Development Goals to a scientific abstract

Primary LanguagePythonGNU Lesser General Public License v3.0LGPL-3.0

OSDG_Logo

NB! From January, 2021 OSDG will be moved to a new repository (https://github.com/osdg-ai/osdg-tool).

All the updates will be made to the new repo only!

OSDG is an open-source tool that assigns labels to scientific content based on Sustainable Development Goals (SDGs).

A version of the OSDG tool is available at OSDG website. There user can classify publications by inputting:

  1. a single DOI,
  2. multiple DOIs in one CSV file,
  3. a text fragment.

Check out our paper on ArXiv OSDG -- Open-Source Approach to Classify Text Data by UN Sustainable Development Goals (SDGs)

A smaller version of the tool to classify text fragments is available at Technote Docker Hub repository.

Usage

NB! We recommend to run OSDG on a machine with at least 24 GB RAM. The tool may not start properly on a smaller machine.

The tool is uploaded to the Docker Hub repository. If you do not have docker installed on your system, please visit Docker page and follow the instructions to install docker on your OS.

To check docker installation run the following command on the terminal on your machine:

docker --version

To download the docker image :

docker pull technoteai/osdg

Then run the downloaded docker image

docker run --name my-osdg -p 5000:5000 --detach technoteai/osdg:latest

The container takes about 2 minutes to fully start.Once it does, it will be running on port 5000. To verify that the container has started and works, enter the following :

docker ps

If the container runs OK, please go to :

http://localhost:5000/

or try the following Python query

import requests

data = { 'query': """Using satellite data on deforestation and weather in Malawi and
        linking those datasets with household survey datasets, we estimate the causal
        effect of deforestation on access to clean drinking water. In the existing
        literature on forest science and hydrology, the consensus is that
        deforestation increases water yield. In this study, we directly examine the
        causal effect of deforestation on households’ access to clean drinking water.
        Results of the two-stage least-squares (2SLS) with cluster and time fixed-effect
        estimations illustrate strong empirical evidence that deforestation decreases
        access to clean drinking water. Falsification tests show that the possibility of
        our instrumental variable picking up an unobserved time trend is very unlikely.
        We find that a 1.0-percentage-point increase in deforestation decreases access
        to clean drinking water by 0.93 percentage points. With this estimated impact,
        deforestation in the last decade in Malawi (14%) has had the same magnitude of
        effect on access to clean drinking water as that of a 9% decrease in rainfall.
        """ }

response = requests.post('http://localhost:5000/search', data=data)

print( response.text )

If you are having trouble with any of the following steps, please contact our team at info@osdg.ai.