Merge pull request #477 from JYOSHREDDY/master

Update README.md

README.md

@@ -1,69 +1,179 @@
-[![CircleCI](https://circleci.com/gh/ZihengSun/Geoweaver/tree/master.svg?style=svg)](https://circleci.com/gh/ZihengSun/Geoweaver/tree/master) [![License](https://img.shields.io/github/license/ESIPFed/Geoweaver.svg)](https://github.com/ESIPFed/Geoweaver/blob/master/LICENSE) [![Stars](https://img.shields.io/github/stars/ESIPFed/Geoweaver.svg)](https://github.com/ESIPFed/Geoweaver/stargazers) [![Forks](https://img.shields.io/github/forks/ESIPFed/Geoweaver.svg)](https://github.com/ESIPFed/Geoweaver/network/members) [![Issues](https://img.shields.io/github/issues/ESIPFed/Geoweaver.svg)](https://github.com/ESIPFed/Geoweaver/issues) [![Coverage](https://img.shields.io/badge/coverage-100%25-success.svg)](https://codecov.io/) 
+![example workflow](
+https://img.shields.io/github/actions/workflow/status/ESIPFed/Geoweaver/release_workflow.yml?style=for-the-badge
+)
+[![License](
+https://img.shields.io/github/license/ESIPFed/Geoweaver?style=for-the-badge
+)](https://github.com/ESIPFed/Geoweaver/blob/master/LICENSE)
+[![Stars](
+https://img.shields.io/github/stars/ESIPFed%2FGeoweaver?style=for-the-badge
+)](https://github.com/ESIPFed/Geoweaver/stargazers) 
+[![Forks](
+https://img.shields.io/github/forks/ESIPFed/Geoweaver?style=for-the-badge&color=%23f2b40a
+)](https://github.com/ESIPFed/Geoweaver/network/members)
+[![Issues](
+https://img.shields.io/github/issues/ESIPFed/Geoweaver?style=for-the-badge&color=%2363c1ff
+)](https://github.com/ESIPFed/Geoweaver/issues) [![Coverage](
+https://img.shields.io/codecov/c/github/ESIPFed/Geoweaver?style=for-the-badge
+)](https://codecov.io/)
+![PyPi](https://img.shields.io/pypi/v/pygeoweaver?style=for-the-badge) 
+![Minimum Java Version](https://img.shields.io/badge/Java-11%2B-%23ed8b02?style=for-the-badge&logo=openjdk
+)
+![Geoweaver Docs](https://img.shields.io/badge/Docs-Geoweaver-%23c4ff7d?style=for-the-badge&logo=readthedocs&link=https%3A%2F%2Fgeoweaver.dev%2F
+)
+
+![logo](src/main/resources/static/img/geoweaver-new-banner.png)
+
+
+### GitHub Repo: https://github.com/ESIPFed/Geoweaver 
+### Pygeoweaver (Python Bindings): https://github.com/ESIPFed/pygeoweaver
+### Live Demo: https://geobrain.csiss.gmu.edu/Geoweaver
+
 
-# [Geoweaver](https://esipfed.github.io/Geoweaver/)
 
 Geoweaver is an in-browser software allowing users to easily compose and execute full-stack data processing workflows via taking advantage of online spatial data facilities, high-performance computation platforms, and open-source deep learning libraries. It provides all-in-one capacity covering server management, code repository, workflow orchestration software, and history recorder. 
 
 It can be run from both local and remote (distributed) machines.
 
-Why choose Geoweaver?
+# Why choose Geoweaver?
+
 1) Safely Store all your progress along the way.
 2) Stay organised and productive through out your years-long research
 4) Seamlessly connect to external servers with SSH.
 5) In-Built Web UI with full support for Python.
 
+For further insights into Geoweaver, please explore the website at https://geoweaver.dev.
 GeoWeaver is a community effort. Any contribution is welcome and greatly appreciated! 
 
-# Software Goals
+# Features
+
+1) **Host Management**:
+  - Register machines via SSH as hosts for running processes.
+  - Add Jupyter Servers as host resources for interaction and workflow editing.
 
-Only two things basically:
+2) **Process Variety**:
+  - Add various types of processes, such as bash scripts for data downloading.
 
-1. Make it time affordable for less-coder scientists (who know nothing about WfMS) to manage their data processing workflows
+3) **Jupyter Notebook Integration**:
+  - Upload or import Jupyter notebooks.
+  - Intercept websocket traffic to save notebook versions, enabling easy revision history access.
 
-2. Preserve all the model run history and share them along with the code files
+4) **Process History and Logging**:
+  - Detailed history of every process run, including logs and outputs, is stored.
 
-# [Installation](docs/install.md)
+5) **Workflow Management**:
+  - Link processes to create workflows for parallel or sequential execution across different resources.
+  - All aspects of workflow management are centralized within GeoWeaver.
 
-# [Upgrade](docs/upgrade.md)
+6) **Boosts Data Pipeline's Tangibility**:
+  - Geoweaver provides an intuitive, interactive interface for visualizing data workflows, making it easier for users to understand and manage complex data pipelines.
+  - This clear visualization helps users to see the connections and dependencies between different components of their workflows.
 
-# [Tutorial](https://zihengsun.github.io/Geoweaver/)
+7) **Enhances Research Productivity and Reduces Work Anxiety**:
+  - Geoweaver has automated scheduling and execution of tasks, researchers can set up their workflows to run at specified times or conditions without manual intervention. 
+  - This automation reduces the burden of monitoring and manual execution, allowing researchers to focus on analysis and innovation. 
 
-* [Create and Manipulate Hosts](docs/host.md)
+# [Geoweaver Installation Guide](docs/install.md)
 
-* [Create and Run Processes](docs/process.md)
+Geoweaver is a powerful tool for geospatial data processing, offering a range of features and capabilities. This guide will walk you through the steps to install Geoweaver on your system.
 
-* [Create, Run, and Export Workflows](docs/workflow.md)
+## Prerequisites
 
-* [Jupyter Recording](https://andrewmagill.github.io/#/)
+Before you begin, ensure that you have the following dependencies installed:
+
+- Java 1.8 or higher (OpenJDK 8 or higher)
+- Docker (required only for the Docker installation method)
 
 # Demo
 
 [A live demo site](https://geobrain.csiss.gmu.edu/Geoweaver) is available.
 
+[//]: # (Add a lot of GIFs)
+
+# Usage
+
+[//]: # (colab, binder, GIFs)
+[//]: # (Show all features here)
+
+
+
+# Documentation
+
+Learn more about Geoweaver in its official documentation at https://esipfed.github.io/Geoweaver/docs/install.html
+
+
+# [PyGeoWeaver](https://github.com/ESIPFed/pygeoweaver)
+
+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.
+
+Please do visit the PyGeoWeaver GitHub repository.
+
+## Contributors
+
+Thanks to our many contributors!
+
+[![Contributors](https://contrib.rocks/image?repo=ESIPFed/Geoweaver)](https://github.com/ESIPFed/Geoweaver/graphs/contributors)
+
+# Geoweaver History
+
+## Version 1.0 (July 2020)
+
+The first stable release of Geoweaver was launched in July 2020 after nearly a year of active development. Key features included:
+
+* Support for various vector and raster data formats
+* Interactive mapping with pan, zoom, and layer control
+* Basic geoprocessing tools (buffer, clip, dissolve, etc.)
+* Python scripting interface for automation
+
+Despite being an early version, Geoweaver quickly gained traction among GIS enthusiasts and developers due to its modern architecture and extensibility.
+
+## Version 2.0 (March 2022)
+
+After incorporating feedback from the user community, the Geoweaver team released version 2.0 in March 2022. This major update focused on performance improvements and added several highly requested features:
+
+* Multiprocessing support for faster geoprocessing
+* 3D visualization and terrain analysis tools
+* Improved symbology and labeling options
+* Integration with popular spatial databases
+
+Version 2.0 solidified Geoweaver's position as a powerful open-source GIS solution and attracted interest from various industries and research institutions.
+
+## Version 3.0 (Upcoming)
+
+The Geoweaver development team is currently working on version 3.0, which is expected to be released in late 2024.
+
+With each new release, the Geoweaver project continues to push the boundaries of open-source GIS software, providing users with a flexible and powerful platform for spatial data management and analysis.
+
+
 # Citation
 
 If you found Geoweaver helpful in your research, please cite: 
 
 Sun, Z. et al., "Geoweaver: Advanced cyberinfrastructure for managing hybrid geoscientific AI workflows." ISPRS International Journal of Geo-Information 9, no. 2 (2020): 119.
 
-# Dependencies
 
-This project is impossible without the support of several fantastic open source libraries.
+# Existing Projects
+
+[//]: # (https://scholar.google.com/scholar?hl=en&as_sdt=0%2C27&q=geoweaver&btnG=)
 
-[d3.js](https://github.com/d3/d3) - BSD 3-Clause
+Sun, Ziheng, Nicoleta C. Cristea, Kehan Yang, Ahmed Alnuaim, Lakshmi Chetana Gomaram Bikshapathireddy, Aji John, Justin Pflug et al. "Making machine learning-based snow water equivalent forecasting research productive and reusable by Geoweaver." In AGU fall meeting abstracts, vol. 2022, pp. IN23A-04. 2022.
 
-[graph-creator](https://github.com/cjrd/directed-graph-creator) - MIT License
+Sun, Ziheng, and Nicoleta Cristea. "Geoweaver for Automating ML-based High Resolution Snow Mapping Workflow." In AGU Fall Meeting Abstracts, vol. 2021, pp. IN11C-07. 2021.
 
-[bootstrap](https://github.com/twbs/bootstrap) - MIT License
+Sun, Ziheng, Liping Di, Jason Tullis, Annie Bryant Burgess, and Andrew Magill. "Geoweaver: Connecting Dots for Artificial Intelligence in Geoscience." In AGU Fall Meeting Abstracts, vol. 2020, pp. IN011-02. 2020.
 
-[CodeMirror](https://github.com/codemirror/CodeMirror) - MIT License
+Sun, Ziheng, Liping Di, Annie Burgess, Jason A. Tullis, and Andrew B. Magill. "Geoweaver: Advanced cyberinfrastructure for managing hybrid geoscientific AI workflows." ISPRS International Journal of Geo-Information 9, no. 2 (2020): 119.
 
-[JQuery Terminal](https://github.com/jcubic/jquery.terminal) - MIT License
+Sun, Ziheng, Liping Di, Jason Tullis, Annie Bryant Burgess, and Andrew Magill. "Geoweaver: Connecting Dots for Artificial Intelligence in Geoscience." In AGU Fall Meeting Abstracts, vol. 2020, pp. IN011-02. 2020.
 
-# [Community](docs/authors.md)
 
 # License
 
-MIT
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Kibble
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.