Skip to content

Commit

Permalink
Merge branch 'master' into dependabot/pip/aiohttp-3.9.2
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysrevans3 authored Feb 28, 2024
2 parents e220569 + 6563d77 commit 08876af
Show file tree
Hide file tree
Showing 120 changed files with 2,948 additions and 6,052 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/formatting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python 3.8
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: 3.8
python-version: 3.9
- name: Python Blacken
uses: psf/black@stable
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.7, 3.8]
python-version: ['3.9', '3.10', '3.11']

steps:
- uses: actions/checkout@v1
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.idea
*.egg-info
*venv
conf
.vscode
conf.yml
__pycache__
*.pyc
Expand All @@ -11,3 +11,4 @@ docs/build/
stac_generator-1.0.2.zip
.lock
GLOB-0.log
cprofile
4 changes: 2 additions & 2 deletions docs/source/api/stac_generator/stac_generator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ STAC Generator

:fa:`github` `View on Github <https://github.com/cedadev/stac-generator>`_

.. automodule:: stac_generator.core.processor
.. automodule:: stac_generator.core.extraction_method
:members:

.. autoclass:: stac_generator.core.generator.BaseGenerator

.. automodule:: stac_generator.core.collection_describer
.. automodule:: stac_generator.core.baker
:members:
110 changes: 0 additions & 110 deletions docs/source/collection_descriptions/building_a_workflow.rst

This file was deleted.

139 changes: 0 additions & 139 deletions docs/source/collection_descriptions/collection_descriptions.rst

This file was deleted.

20 changes: 7 additions & 13 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,11 @@ change the source of the files, the output of the metadata and the processing ch
which extracts the metadata. The framework leverages a modular, plugin architecture
to allow users to modify the workflow to fit their needs.

The process expects a stream of "assets" (an asset being a file, zarr object, etc.).
The process expects a stream of "messages" for which the recipes can be run against.
The source of this stream is configured with `input plugins <stac_generator/inputs>`_
which could be as simple as listing directories on a file system or using message
queues as part of a complex ingest system. The `generators <generators>`_ operate on this stream and
pass to `output plugins <stac_generator/outputs>`_. The output is at the level
of an "asset" so higher level aggregated objects may require an aggregation step.
pass to `output plugins <stac_generator/outputs>`_.

These outputs are also configurable so could dump to the terminal (for debugging), file,
a data store (postgres, elasticsearch, etc.) or even a message queue for onward processing.
Expand All @@ -36,22 +35,17 @@ in a certain space and time.
Generators
==========

The different generators are designed to extract different levels of metadata to build the assets, items, and collections of the STAC Catalog.
The different generators are designed to extract different levels of metadata to build the items, and collections of the STAC Catalog.

.. list-table::
:header-rows: 1

* - Name
- Description
* - :ref:`Asset Generator <stac_generator/generators:asset>`
- Generates STAC Assets via extraction methods specified in the :ref:`colelction descriptions <collection_descriptions/collection_descriptions:collection descriptions>`
focusing on file metadata (name, location, size, etc.)
* - :ref:`Item Generator <item_generator/generators:item>`
- Generates STAC Items via extraction methods specified in the :ref:`colelction descriptions <collection_descriptions/collection_descriptions:collection descriptions>`
focusing on aggregation from asset metadata.
* - :ref:`Collection Generator <stac_generator/generators:collection>`
- Generates STAC Collections via extraction methods specified in the :ref:`colelction descriptions <collection_descriptions/collection_descriptions:collection descriptions>`
focusing on aggregation from item metadata.
* - :ref:`Item Generator <item_generator/plugins/generators/item>`
- Generates STAC Items via extraction methods specified in the :ref:`colelction descriptions <recipe/recipes>`.
* - :ref:`Collection Generator <stac_generator/plugins/generators/collection>`
- Generates STAC Collections via extraction methods specified in the relivant :ref:`recipe <recipe/recipes>`.



Expand Down
Loading

0 comments on commit 08876af

Please sign in to comment.