From f5c65e498d15cb668eb53ead0ab62cb53d739015 Mon Sep 17 00:00:00 2001 From: Alper Altuntas Date: Mon, 28 Oct 2024 18:57:50 -0600 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 03855a4..ecd847e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,20 @@ # visualCaseGen -visualCaseGen is a prototype GUI that runs on JupyterLab. This tools visually guides the users through the process of creating CESM cases, e.g., choosing appropriate compsets and grids. Check out the following Quickstart guide for more information on how to work with visualCaseGen: +Welcome to **visualCaseGen**, an intuitive graphical user interface (GUI) designed to simplify the workflow of creating Community Earth System Model v.3 (CESM3) cases. With visualCaseGen, users can effortlessly explore and define component sets (compsets), select or customize grid resolutions, and prepare their CESM cases, all through an interactive and user-friendly platform that runs on Jupyter notebooks. -https://github.com/ESMCI/visualCaseGen/wiki/Quickstart +## Key Features + +- **Guided Configuration**: visualCaseGen guides users through the main steps of configuring CESM cases, ensuring that all necessary components are included while preventing incompatible selections. + +- **Standard and Custom Options**: Users can choose from predefined standard compsets and grids or create custom configurations tailored to specific modeling needs. + +- **Real-Time Compatibility Checks**: As you make selections, visualCaseGen highlights incompatible options, helping you navigate the complexities of model configurations effectively. + +- **Easy Navigation**: The tool breaks down the configuration process into three clear stages: + 1. **Compset Selection**: Choose from standard or custom compsets, including all associated models and physics options. + 2. **Grid Configuration**: Select or create grids tailored for your application, ensuring compatibility across individual component grids and compsets. + 3. **Case Launch**: Finalize your configuration and create your CESM case with a few clicks. + +## User Manual + +For detailed instructions on how to use visualCaseGen, including setup and configuration guidance, please refer to the [User Manual](https://esmci.github.io/visualCaseGen/).