-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from ZihengSun/main
add doc and stats
- Loading branch information
Showing
1 changed file
with
68 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +1,119 @@ | ||
|
|
||
| ## PyGeoWeaver | ||
|
|
||
| ### Description | ||
| || | | ||
| |--|--| | ||
| |Latest Release| | | ||
| |Getting Help| [](https://pygeoweaver.readthedocs.io/en/latest/?badge=latest) | | ||
| |Activity| | | ||
| |Community| | | ||
| |License|| | ||
|
|
||
| This package is a Python wrapper of the GeoWeaver app which was written in Java. This package is designed for Jupyter users to be able to directly use Geoweaver in Jupyter notebook or JupyterLab (JupyterHub). | ||
| 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 | ||
| ## Installation | ||
|
|
||
| `pip install pygeoweaver` | ||
| To install PyGeoWeaver, simply use pip: | ||
|
|
||
| ### Usage | ||
| ```bash | ||
| pip install pygeoweaver | ||
| ``` | ||
|
|
||
| 1. To show Geoweaver graphic user interface, please create a new cell and type: | ||
| ## 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/](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: | ||
|
|
||
| ```python | ||
| import geoweaver | ||
| geoweaver.start() | ||
| ``` | ||
|
|
||
| The command will first check if Geoweaver has been downloaded and installed. If no, it will automatically download and install Geoweaver in the local environment. Then it will open Geoweaver in the cell output in a iframe. Users can use all the functions provided in Geoweaver. | ||
| 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. | ||
|
|
||
| 2. To stop Geoweaver, please run: | ||
| 2. **Stopping GeoWeaver**: To stop GeoWeaver, use the following command: | ||
|
|
||
| ``` | ||
| ```python | ||
| geoweaver.stop() | ||
| ``` | ||
|
|
||
| 3. To list the existing objects, please run: | ||
| 3. **Listing Existing Objects**: To list the existing hosts, processes, and workflows, execute the respective commands: | ||
|
|
||
| ``` | ||
| ```python | ||
| geoweaver.list_hosts() | ||
| geoweaver.list_processes() | ||
| geoweaver.list_workflows() | ||
| ``` | ||
|
|
||
| 4. To run a workflow, please run: | ||
| ``` | ||
| geoweaver.run_workflow("workflow_id", "host_id_list", "password_list", "environment_list") | ||
| ``` | ||
|
|
||
| or | ||
| 4. **Running a Workflow**: To execute a workflow, use the following command: | ||
|
|
||
| ```python | ||
| geoweaver.run_workflow("workflow_id", "host_id_list", "password_list", "environment_list") | ||
| ``` | ||
| geoweaver.run_workflow("workflow_zip_file_path", "host_id_list", "password_list", "environment_list") | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ``` | ||
| geoweaver.run_workflow("workflow_local_folder_path", "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. | ||
|
|
||
| 5. To export a workflow: | ||
| 5. **Exporting a Workflow**: To export a workflow, use the following command: | ||
|
|
||
| ``` | ||
| ```python | ||
| geoweaver.export_workflow("workflow_id", "workflow_zip_save_path") | ||
| ``` | ||
|
|
||
| 6. To import a workflow: | ||
| This command exports the specified workflow to a ZIP file, which is saved at the provided save path. | ||
|
|
||
| ``` | ||
| 6. **Importing a Workflow**: To import a workflow, use the following command: | ||
|
|
||
| ```python | ||
| geoweaver.import_workflow("<workflow_zip_file_path>") | ||
| ``` | ||
|
|
||
| or | ||
| Alternatively, you can import a workflow by specifying the path to the workflow folder. | ||
|
|
||
| ``` | ||
| geoweaver.import_workflow("<workflow_folder_path>") | ||
| ``` | ||
|
|
||
| 7. To get history of a workflow run: | ||
| 7. **Viewing Workflow and Process History**: To retrieve the history of a workflow run or a process run, use the respective commands: | ||
|
|
||
| ``` | ||
| ```python | ||
| geoweaver.history("<workflow_history_id>") | ||
| ``` | ||
|
|
||
| 8. To get history of a process run: | ||
|
|
||
| ``` | ||
| geoweaver.history("<process_history_id>") | ||
| ``` | ||
|
|
||
| 9. To check the source code of a process | ||
| 8. **Inspecting Process Source Code**: To view the source code of a process, use the following command: | ||
|
|
||
| ``` | ||
| geoweaver.detail_processs("<process_id>") | ||
| ```python | ||
| geoweaver.detail_process("<process_id>") | ||
| ``` | ||
|
|
||
| 10. To check the configuration of a workflow | ||
| 9. **Inspecting Workflow Configuration**: To check the configuration details of a workflow, execute the following command: | ||
|
|
||
| ``` | ||
| ```python | ||
| geoweaver.detail_workflow("<workflow_id>") | ||
| ``` | ||
|
|
||
| 11. To check the details of a host: | ||
| 10. **Inspecting Host Details**: To retrieve the details of a host, use the following command: | ||
|
|
||
| ``` | ||
| ```python | ||
| geoweaver.detail_host("<host_id>") | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| For detailed documentation and examples, please visit the [PyGeoWeaver Documentation](https://pygeoweaver.readthedocs.io/). | ||
|
|
||
| ## 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! |