diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..f5a0228 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,42 @@ +# Clawpack Community NumFOCUS Code of Conduct + +As a [NumFOCUS](https://numfocus.org) affiliated project we have elected to +adopt the NumFOCUS code of conduct. + +## The Short Version + +NumFOCUS and the Clawpack community is dedicated to providing a +harassment-free community for everyone, regardless of gender, sexual +orientation, gender identity and expression, disability, physical appearance, +body size, race, or religion. We do not tolerate harassment of community +members in any form. + +Be kind to others. Do not insult or put down others. Behave professionally. +Remember that harassment and sexist, racist, or exclusionary jokes are not +appropriate for NumFOCUS or Clawpack. + +All communication should be appropriate for a professional audience including +people of many different backgrounds. Sexual language and imagery is not +appropriate. + +Thank you for helping make this a welcoming, friendly community for all. + +## Long Version + +You can find the long version of the Code of Conduct on the NumFOCUS website +https://numfocus.org/code-of-conduct. + +## How To Report + +If you feel that the Code of Conduct has been violated, feel free to submit a +report, by using the form: [NumFOCUS Code of Conduct Reporting Form](https://numfocus.typeform.com/to/ynjGdT?typeform-source=numfocus.org). + +## Who Will Receive Your Report + +Your report will be received and handled by NumFOCUS Code of Conduct Working +Group; trained, and experienced contributors with diverse backgrounds. The +group is making decisions independently from the Clawpack project, PyData, +NumFOCUS or any other organization. + +You can learn more about the current group members, as well as the reporting +procedure [HERE](https://numfocus.org/code-of-conduct). diff --git a/README.md b/README.md index 7286992..f22082f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,19 @@ # Classic Clawpack -This package hosts the single-grid version of the Clawpack code. All of the Clawpack solvers include the *classic* algorithms described in [LeVeque-FVMHP](https://www.clawpack.org/fvmhp_materials/) [DOI](https://doi.org/10.1017/CBO9780511791253). +This package hosts the single-grid version of the Clawpack code. -**Links** - - [Documentation](https://www.clawpack.org/) - - ![Tests](https://github.com/clawpack/classic/actions/workflows/testing.yml/badge.svg) +See the main [clawpack/clawpack repository](https://github.com/clawpack/clawpack) + README for more links. + +See the [Documentation](https://www.clawpack.org/) +for more details and installation instructions. + +All of the Clawpack solvers include the *classic* algorithms described in +LeVeque's book [Finite Volume Methods for Hyperbolic +Problems](https://www.clawpack.org/fvmhp_materials/). +Many of the examples from that book can be run using code in the +[Clawpack apps](https://www.clawpack.org/apps.html) repository, see +[Examples from the book FVMHP](https://www.clawpack.org/fvmbook.html). + + +![Tests](https://github.com/clawpack/classic/actions/workflows/testing.yml/badge.svg)