We are building FarEarth to be intuitive. Clear documentation is offered on GitHub and the FarEarth portal for those who wish to expand their capabilities on FarEarth. We empower users to help themselves!
FarEarth is an automated processing and data management platform for creating high-quality orthorectified image products. It allows for customisation with processors and workflows while giving you control over data ingestion, storage, and archiving.
We have documentation to help you configure FarEarth; documentation that describes our processing algorithms and product formats; and documentation to help you integrate FarEarth with your system.
What can you configure in FarEarth?
Data is ingested into FarEarth via pickups for processing. Configuration of pickups can be found under the DATAPOINT CONFIG menu.
In the pickup configuration, you can specify the source of the data, such as an Amazon S3 bucket or Microsoft Azure blob storage. You can indicate how new data is detected. Is there a manifest file containing a list of files, a sidecar file referring to an entire folder, or individual ZIP files? You can control what happens to the products once ingested. Do you retain them, move them to another location, or delete them after a specific period?
Processed data is stored in Archives. Archives are configured under the CATALOGUE CONFIG menu.
For Archives, you can specify the protocol to use, as well as what happens when the Archive becomes too full. Must FarEarth send a warning or error message when the Archive is full, or do you want FarEarth to start removing the oldest products in the Archive automatically?
Workflows are configured under the DEVELOPER menu, allowing you to create your own workflows using your executors—a topic for another blog.
No black box!
To process vast quantities of data from satellite constellations, we automate as much as possible. However, we do not create black boxes! We strongly advocate for standardisation, traceability, and transparency!
We use standard product formats. By default, products are STAC-compliant with cloud-optimised GeoTIFFs (COGs). You can find a list of data format descriptions in our documentation, along with schema files to assist you in working with the data.
FarEarth utilises scientifically accepted algorithms to process all imagery. FarEarth algorithms are documented in our algorithm description documentation (ATBDs).
How can you integrate with FarEarth?
Everything that you see in the FarEarth portal can also be accessed via APIs. Our API documentation will get you started quickly.
FarEarth features a built-in tool for testing and experimenting with the various APIs within the portal. To access the interactive API functions, navigate to the API page under the DEVELOPER menu.
As is customary, there is a simple “Hello World” example.
Python examples are available on our GitHub page to demonstrate how to interact with the APIs. We provide OpenAPI schema definition files.
Where to find the documentation
All system documentation is available directly in the portal.
On GitHub, we provide the system documentation and many helpful resources: https://github.com/pinkmatter.
Here are some useful pages on GitHub:
- System documentation: https://github.com/pinkmatter/sys-docs
- API examples: https://github.com/pinkmatter/farearth-api-examples
- Schemas and ATBDs: https://github.com/pinkmatter/farearth-docs
Visit our Resources page on our website for additional resources!
Happy reading!