Skip to content

Commit

Permalink
update readmes, clean up extensions and add markdown linter
Browse files Browse the repository at this point in the history
  • Loading branch information
twelch committed Jan 30, 2023
1 parent ac28f80 commit 0bd9cbf
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 18 deletions.
3 changes: 1 addition & 2 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
"recommendations": [
"ms-vscode.vscode-typescript-tslint-plugin",
"esbenp.prettier-vscode",
"jumpinjackie.vscode-map-preview",
"vtrois.gitmoji-vscode"
"DavidAnson.vscode-markdownlint"
]
}
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
# Geoprocessing

A serverless framework for publishing low-cost and low-maintenance `geoprocessing` services and reports in the cloud. Part of the [SeaSketch](https://seasketch.org/) ecosystem.
All-in-one solution for developing low-cost and low-maintenance geoprocessing functions and reports for the web, with Typescript. Simplified publish to cloud with auto-scaling to meet high demand.

This framework is part of the [SeaSketch](https://seasketch.org) ecosystem.

* [Documentation](https://github.com/seasketch/geoprocessing/wiki)
* [Changelog](https://github.com/seasketch/geoprocessing/blob/dev/CHANGELOG.md)

## Who is this framework for?

This framework is primarily designed for people that want to create and host their own geoprocessing functions and reports and plug them into their SeaSketch project, though it is not dependent on SeaSketch. It is used for all SeaSketch [projects](https://github.com/seasketch/geoprocessing/network/dependents?package_id=UGFja2FnZS0xMTc3OTQ1NDg5).

## Goals

* [Serverless](https://aws.amazon.com/lambda/serverless-architectures-learn-more/) architecture that scales up to meet high demand, then scales down to near zero cost when not in use.
* First-class [Typescript](https://www.typescriptlang.org/) development experience.
* Utilize cloud-optimized data formats including [Flatgeobuf](https://flatgeobuf.org/) and [Cloud-optimized GeoTIFFs (COGs)](https://www.cogeo.org/)
* Open source
16 changes: 2 additions & 14 deletions packages/geoprocessing/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,8 @@
# Geoprocessing

A serverless framework for publishing low-cost and low-maintenance `geoprocessing` services and reports in the cloud. Part of the [SeaSketch](https://seasketch.org/) ecosystem.
This is the core library of `geoprocessing`, a serverless framework for publishing low-cost and low-maintenance geoprocessing functions and reports in the cloud. Part of the [SeaSketch](https://seasketch.org/) ecosystem.

## What is this for?

This frameworks niche is running spatial analysis, particularly overlay statistics, and generating real-time reports at scale, with different input, such as part of a collaborative spatial planning process.

Often, the original analysis might be prototyped in an environment like R, Jupyter Notebook, ArcGIS, QGIS, etc. and this framework can be used to "operationalize" the analysis at a cost, speed and scale that is hard to match with other products.

## Who is this for?

This framework is specifically targeted to code-savvy folks that want to create and host geoprocessing projects themselves and plug them into their SeaSketch project, though it is not dependent on SeaSketch. The SeaSketch team uses it for all projects, here are some [public ones](https://github.com/seasketch/geoprocessing/network/dependents?package_id=UGFja2FnZS0xMTc3OTQ1NDg5)

The primary efficiency to this framework is that almost everything is written in Typescript/Javascript, both backend and frontend. Third-party tools are accessible via Node bindings (AWS) or a standard shell environment using Docker (OGR, GDAL, PostGIS, Python).

[Geoprocessing Docs](https://github.com/seasketch/geoprocessing#readme)
[Learn More](https://github.com/seasketch/geoprocessing)

## Versions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"recommendations": [
"ms-vscode.vscode-typescript-tslint-plugin",
"esbenp.prettier-vscode",
"amazonwebservices.aws-toolkit-vscode"
"amazonwebservices.aws-toolkit-vscode",
"DavidAnson.vscode-markdownlint"
]
}

0 comments on commit 0bd9cbf

Please sign in to comment.