/gplates-web-service

Source code for GPlates Web Service(GWS)

Primary LanguagePythonGNU General Public License v2.0GPL-2.0

GPlates Web Service

The 🔥GPlates Web Service🔥 is a part of the on-going GPlates project funded by AuScope. The web service is built upon pygplates. It allows users to utilize the pygplates functionalities without installing pygplates locally. Users can send HTTP requests to https://gws.gplates.org to get the reconstruction results back. This enables pygplates functionalities in any programming languanges and on any operation systems.

The web serivce is also containerized(https://hub.docker.com/r/gplates/gws). Users can choose to deploy the Docker containers locally to enhance performance and data security.

The GPlates Web Service is created and maintained by EarthByte group at the University of Sydney.

📂Contents

  • django -- folder contains source code files for backend services (using django framework).

  • docker -- folder contains files for building Docker image

  • doc -- documentation website. This doc website is built upon gatsby-gitbook-starter.

  • examples -- some examples to show how to use this web service

  • test -- code for testing this web service

  • examples of accessing the service from different languages (R,matlab,bash/GMT,python) have now been moved to https://github.com/siwill22/gws-examples

🐳Docker

click 👉here👈 to see details about using Docker in development and production environment.

📚Documentation

Go to GWS documentation website

The Swagger UI is at https://gws.gplates.org/swagger-ui/

The OpenAPI schema is at https://gws.gplates.org/openapi

📮Contact

👉 Contact EarthByte

📝License

The GPlates Web Service is free software (also known as open-source software), licensed for distribution under the GNU General Public License (GPL), version 2.

Dev

  • ./docker/start-postgis.sh
  • ./docker/start-gws-dev.sh

Test