Skip to content

Commit

Permalink
Add Contributing and Documentation sections to README
Browse files Browse the repository at this point in the history
  • Loading branch information
sfield17 committed Jan 17, 2025
1 parent 7ebda3b commit 998d407
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 #

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 998d407

Please sign in to comment.