Skip to content

Commit 6ffd3aa

Browse files
authored
Merge pull request #306 from rjleveque/CoC
add Code of Conduct
2 parents 5077357 + 5bf5812 commit 6ffd3aa

File tree

2 files changed

+52
-1
lines changed

2 files changed

+52
-1
lines changed

CODE_OF_CONDUCT.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Clawpack Community NumFOCUS Code of Conduct
2+
3+
As a [NumFOCUS](https://numfocus.org) affiliated project we have elected to
4+
adopt the NumFOCUS code of conduct.
5+
6+
## The Short Version
7+
8+
NumFOCUS and the Clawpack community is dedicated to providing a
9+
harassment-free community for everyone, regardless of gender, sexual
10+
orientation, gender identity and expression, disability, physical appearance,
11+
body size, race, or religion. We do not tolerate harassment of community
12+
members in any form.
13+
14+
Be kind to others. Do not insult or put down others. Behave professionally.
15+
Remember that harassment and sexist, racist, or exclusionary jokes are not
16+
appropriate for NumFOCUS or Clawpack.
17+
18+
All communication should be appropriate for a professional audience including
19+
people of many different backgrounds. Sexual language and imagery is not
20+
appropriate.
21+
22+
Thank you for helping make this a welcoming, friendly community for all.
23+
24+
## Long Version
25+
26+
You can find the long version of the Code of Conduct on the NumFOCUS website
27+
https://numfocus.org/code-of-conduct.
28+
29+
## How To Report
30+
31+
If you feel that the Code of Conduct has been violated, feel free to submit a
32+
report, by using the form: [NumFOCUS Code of Conduct Reporting Form](https://numfocus.typeform.com/to/ynjGdT?typeform-source=numfocus.org).
33+
34+
## Who Will Receive Your Report
35+
36+
Your report will be received and handled by NumFOCUS Code of Conduct Working
37+
Group; trained, and experienced contributors with diverse backgrounds. The
38+
group is making decisions independently from the Clawpack project, PyData,
39+
NumFOCUS or any other organization.
40+
41+
You can learn more about the current group members, as well as the reporting
42+
procedure [HERE](https://numfocus.org/code-of-conduct).

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,17 @@
11
# AMRClaw Package
2+
3+
This package hosts the Adaptive Mesh Refinement version of the Clawpack code.
4+
5+
See the main [clawpack/clawpack repository](https://github.com/clawpack/clawpack)
6+
README for more links.
7+
8+
See the [Documentation](https://www.clawpack.org/)
9+
for more details and installation instructions.
10+
211
The AMRClaw version of Clawpack provides Adaptive Mesh Refinement (AMR) capabilities in 2 and 3 space dimensions. (The two-dimensional code can also be used for 1-dimensional problems, see [AMRClaw for 1d problems](https://www.clawpack.org/amrclaw1d.html#amrclaw-1d).)
312

413
Block-structured AMR is implemented, in which rectangular patches of the grid at level `L` are refined to level `L+1`. The general algorithms are described in [BergerLeVeque98](https://doi.org/10.1137/S0036142997315974).
514

615
**Links**
7-
- [Documentation](https://www.clawpack.org/amrclaw.html)
16+
- [Documentation for AMRClaw](https://www.clawpack.org/amrclaw.html)
817
- [![Tests](https://github.com/clawpack/amrclaw/actions/workflows/testing.yml/badge.svg)](https://github.com/clawpack/amrclaw/actions/workflows/testing.yml)

0 commit comments

Comments
 (0)