From 998d407290e8d275dc7c6f4ed37d7b3e5b17f8a9 Mon Sep 17 00:00:00 2001 From: Scott Field Date: Fri, 17 Jan 2025 15:16:21 -0500 Subject: [PATCH] Add Contributing and Documentation sections to README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index e9c35bd..47dd50b 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,13 @@ Alternatively, if you are a bash or sh user, edit your .profile export PYTHONPATH=~absolute_path_to_gws_folder:$PYTHONPATH ``` +# Documentation + + Explore our [Jupyter Notebooks](https://github.com/sxs-collaboration/gwsurrogate/blob/master/tutorial/website) for a comprehensive overview of individual models and the user-level API. For an introductory explanation of the surrogate modeling methodology used in GWSurrogate, check out these videos: + + - [Introduction to the GWSurrogate package](https://icerm.brown.edu/video_archive/2413) + - [Overview of surrogate modeling methodology](https://icerm.brown.edu/video_archive/2412) + # Usage # @@ -209,6 +216,24 @@ to run some regression tests. >>> pytest -v -s # run all tests with high verbosity ``` +# Contributing + +We welcome contributions! Here's how you can get involved: + +1. **Report Bugs or Suggest Enhancements**: + Use the [GitHub issue tracker](https://github.com/sxs-collaboration/gwsurrogate/issues) to report bugs or suggest new features. Before submitting, consider browsing through existing issues to see if your concern has already been addressed. A developer will respond to issues that are opened on GitHub. + +2. **Contribute Code**: + We use the [fork and pull request model](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) for code contributions. Fork the repository, make your changes, and submit a pull request. + +Please ensure you follow our [Code of Conduct](https://github.com/sxs-collaboration/gwsurrogate?tab=coc-ov-file) when contributing. + + + + + + + # NSF Support # This package is based upon work supported by the National Science Foundation