This readme file was generated on * YYYY-MM-DD * by * NAME *
<!---
Visit [Writing READMEs for Research Code & Software](https://data.research.cornell.edu/data-management/sharing/writing-readmes-for-research-code-software/) guidance for more details

[!Note] * help text within asterisks should be replaced with suggested information and deleted before finalizing your document *
-->
# General Information

- Project name: * Provide a descriptive project title (note: this title should be distinct from publications or datasets) *
- Version: * Provide a version using semantic versioning, so that it is clear how earlier versions relate to the most current version of the code (e.g., v1.2.0) *
- Short description: * Provide a one sentence summary of the software's purpose or functionality. This should serve as a quick overview, distinct from the full project description below. (e.g., Python tool for visualizing climate model outputs) *

# Project Overview

- Full description: * Provide a detailed description of the software's purpose, including notable features *   
- Date of creation: * Provide the date of creation of the software or the latest version release (single date(YYYY-MM-DD), or a range (YYYY-MM-DD - YYYY-MM-DD)) *
- Project Organization: * Provide information on the following as applicable: source code, pre-compiled binaries, tests, configuration files, build scripts, dependencies, documentation, static resources *
- Software project size: * Provide the total size of the project or its components (uncompressed) *

# Installation

- Step by step instructions: * Provide step-by-step installation instructions to install and set up your software project on a user's system *
- System requirements: * Provide system requirements, such as the operating system and any other system-level dependencies *
- Required libraries, packages, modules: * Provide a list of required dependencies (e.g., libraries, packages, modules, etc.) *
        [!Tip] * A package management tool can generate a list of dependencies for a project (e.g., Python’s pip freeze will output a list of installed packages in a format that can be used to create a “requirements.txt” file) *
- Setup requirements: * Provide a description of any setup requirements (e.g., environment variables, configuration files) *
- Known issues: * Provide any known issues or caveats during installation. (e.g., compatibility issues or known bugs) *
 

# Usage
 
- Step by step instructions: * Provide instructions on how run the software or execute the code after all of the required software project has been installed and include a brief description of what the expected output or behaviour should be *
        * Provide usage examples * 
        * Include screenshots where appropriate * 
        * Document how to run any built-in tests *
- Known limitations: * Note any known caveats or limitations  *

# License

-  Software License: * Provide a license (e.g., MIT) and LICENSE file and/or explain any restrictions on use *
        [!Note] * This should also be in the source code as well * 
        * Visit https://choosealicense.com for useful and short summaries on the licenses *
-  Preferred citation: * Provide a citation that users can reference in publications * 

# Contact Information
[!Note] * Provide at least two contacts; repeat block for additional contributors as needed *

## Contact 
Name:  
Role: * (e.g., principal investigator, programmer, developer, maintainer, copyright owner) *  
ORCID:  
Institution:  
Email 

## Contact 
Name:  
Role: * (e.g., principal investigator, programmer, developer, maintainer, copyright owner) *  
ORCID:  
Institution:  
Email 

# Acknowledgements

- Funding: * Provide a list of funding sources that supported the creation of the software project; include funder name and grant number(s). *
- Publications using our software: * Cite any publications using this software project *
- Project is available: * Link to other locations where the software project is available (e.g., Zenodo, GitHub, institutional repository) *
- Related relationships: * List relationships to ancillary scripts, applications, or data sets *
- Contributors: * List all contributors and their roles *