emissions-api

A solution that provides simple access to emissions data of climate-relevant gases.
https://github.com/emissions-api/emissions-api

Category: Emissions
Sub Category: Emission Observation and Modeling

Keywords

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

Keywords from Contributors

measur transforms observation archiving compose geoprocessing geography reporting sharing projection

Last synced: about 17 hours ago
JSON representation

Repository metadata

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 (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T04:23:07.000Z (12 months ago)
• Last Synced: 2025-04-17T22:43:48.227Z (9 days 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: 77
• Watchers: 4
• Forks: 11
• Open Issues: 23
• Releases: 0
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Security: SECURITY.rst

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 metadata

• Name: Emissions API
• Login: emissions-api
• Email:
• Kind: organization
• Description: Easy access to satellite-based emission data for everyone
• Website: https://emissions-api.org
• Location: Osnabrück, Germany
• Twitter: emissions_api
• Company:
• Icon url: https://avatars.githubusercontent.com/u/47664099?v=4
• Repositories: 7
• Last ynced at: 2023-03-03T02:45:25.788Z
• Profile URL: https://github.com/emissions-api

---

GitHub Events

Total

• Watch event: 2

Last Year

• Watch event: 2

---

Committers metadata

Last synced: 4 days ago

Name	Email	Commits
dependabot-preview[bot]	2****]	97
Lars Kiesow	l****w@u****e	88
dependabot[bot]	4****]	86
Sven Haardiek	s****n@h****e	82
Timo Brockmeyer	t****r@g****m	6
Max Brenner	x****b@g****m	5
Sven Haardiek	s****k@i****e	4
David Dalisay	d****3@g****m	4
Simon Kerssen	S****n@i****e	3
Björn	f****z@g****m	3
EmbeddedHenni	4****i	2
TylerBird	t****0@g****m	1

Committer domains:

• iotec-gmbh.de: 2
• haardiek.de: 1
• uos.de: 1

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/emissions-api/emissions-api

---

---

---

Dependencies

Score: 7.090076835776092