https://github.com/emissions-api/emissions-api

Web API to easily access satellite-based emission data
https://github.com/emissions-api/emissions-api

air-quality citizen-science copernicus emissions-api esa hacktoberfest python remote-sensing sentinel-5

Last synced: about 1 month ago
JSON representation

Web API to easily access satellite-based emission data

• Host: GitHub
• URL: https://github.com/emissions-api/emissions-api
• Owner: emissions-api
• License: mit
• Created: 2019-09-27T11:33:23.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T04:23:07.000Z (8 months ago)
• Last Synced: 2024-10-29T21:01:23.554Z (about 2 months ago)
• Topics: air-quality, citizen-science, copernicus, emissions-api, esa, hacktoberfest, python, remote-sensing, sentinel-5
• Language: Python
• Homepage: https://emissions-api.org
• Size: 6.65 MB
• Stars: 75
• Watchers: 5
• Forks: 11
• Open Issues: 23
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Security: SECURITY.rst

Awesome Lists containing this project

• open-sustainable-technology - emissions-api - A solution that provides simple access to emissions data of climate-relevant gases. (Emissions / Emission Observation and Modeling)

README

        
Emissions API

=============

.. image:: https://img.shields.io/travis/com/emissions-api/emissions-api?label=Docs

   :target: https://docs.emissions-api.org

   :alt: Documentation Status

.. image:: https://github.com/emissions-api/emissions-api/actions/workflows/main.yml/badge.svg

   :target: https://github.com/emissions-api/emissions-api/actions/workflows/main.yml

   :alt: Integration Test

This is the main repository for the `Emissions API `_.

If you just want to use Emissions API as a service, take a look at our `API documentation `_

or visit our `website `_ for additional information and examples.

Below you will find a small introduction about setting the services in this repository up for development.

If you want to take a deeper dive into this, you can take a look at the `documentation `_,

visit the `issues `_

or take a look into the `libraries and tools `_ we created around this project.

Installation

------------

To install the requirements execute

.. code-block:: bash

   pip install -r requirements.txt

You might have to explicitly deal with C-dependencies like ``psycopg2`` yourself,

One way to do this is to use your corresponding system packages.

After that you can run the different services using

* **preprocess**\ : ``python -m emissionsapi.preprocess``

* **autoupdater**\ : ``python -m emissionsapi.autoupdater``

* **web**\ : ``python -m emissionsapi.web``

Configuration

-------------

Emissions API will look for configuration files in the following order:

* ``./emissionsapi.yml``

* ``~/emissionsapi.yml``

* ``/etc/emissionsapi.yml``

A configuration file template can be found at ``etc/emissionsapi.yml``.

To get started, just copy this to the main project directory and adjust the

values if the defaults do not work for you.

Database Setup

--------------

This project is using a `PostgreSQL `_ database with the `PostGIS `_ extension.

There is a simple ``docker-compose.yml`` file to make it easier to setup a

database for development.