Skip to content

Latest commit

 

History

History
119 lines (77 loc) · 4.62 KB

README.md

File metadata and controls

119 lines (77 loc) · 4.62 KB
Raw

PyGeoWeaver
Latest Release Static Badge PyPI
Getting Help Documentation Status
Activity PyPI - Downloads GitHub commit activity (branch)
Community Static Badge
License GitHub

PyGeoWeaver is a Python package that provides a convenient and user-friendly interface to interact with GeoWeaver, a powerful geospatial data processing application written in Java. With PyGeoWeaver, Jupyter notebook and JupyterLab users can seamlessly integrate and utilize the capabilities of GeoWeaver within their Python workflows.

Installation

To install PyGeoWeaver, simply use pip:

pip install pygeoweaver

Features

  • Simplified creation of geospatial processes and workflows.
  • Support for multiple programming languages.
  • Seamless integration with the GeoWeaver API for efficient process execution.
  • Comprehensive documentation available at https://pygeoweaver.readthedocs.io/.

Usage

  1. Launching GeoWeaver GUI: To open the GeoWeaver graphical user interface, create a new cell and execute the following code:
import geoweaver
geoweaver.start()

This command checks if GeoWeaver is already installed. If not, it will automatically download and install GeoWeaver in your local environment. The GeoWeaver interface will then open in the cell output as an iframe, allowing you to access and utilize all the features provided by GeoWeaver.

  1. Stopping GeoWeaver: To stop GeoWeaver, use the following command:
geoweaver.stop()
  1. Listing Existing Objects: To list the existing hosts, processes, and workflows, execute the respective commands:
geoweaver.list_hosts()
geoweaver.list_processes()
geoweaver.list_workflows()
  1. Running a Workflow: To execute a workflow, use the following command:
geoweaver.run_workflow("workflow_id", "host_id_list", "password_list", "environment_list")

Alternatively, you can run a workflow by specifying the path to the workflow ZIP file or the local folder containing the workflow files.

  1. Exporting a Workflow: To export a workflow, use the following command:
geoweaver.export_workflow("workflow_id", "workflow_zip_save_path")

This command exports the specified workflow to a ZIP file, which is saved at the provided save path.

  1. Importing a Workflow: To import a workflow, use the following command:
geoweaver.import_workflow("<workflow_zip_file_path>")

Alternatively, you can import a workflow by specifying the path to the workflow folder.

  1. Viewing Workflow and Process History: To retrieve the history of a workflow run or a process run, use the respective commands:
geoweaver.history("<workflow_history_id>")
geoweaver.history("<process_history_id>")
  1. Inspecting Process Source Code: To view the source code of a process, use the following command:
geoweaver.detail_process("<process_id>")
  1. Inspecting Workflow Configuration: To check the configuration details of a workflow, execute the following command:
geoweaver.detail_workflow("<workflow_id>")
  1. Inspecting Host Details: To retrieve the details of a host, use the following command:
geoweaver.detail_host("<host_id>")

Documentation

For detailed documentation and examples, please visit the PyGeoWeaver Documentation.

Contributing

Contributions to PyGeoWeaver are welcome!

If you encounter any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on the GitHub repository.

License

PyGeoWeaver is licensed under the MIT License.

Thank you for choosing PyGeoWeaver! We hope this package enhances your geospatial data processing workflows. If you have any questions or need assistance, please refer to the documentation or reach out to us. Happy geospatial processing!