emissions-api

Web API to easily access satellite-based emission data

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

Keywords

Keywords from Contributors

Repository

Web API to easily access satellite-based emission data

README.rst

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.

Owner

GitHub Events

Committers

Last synced: 7 months ago

Issues and Pull Requests

Last synced: 6 months ago