|
1 | 1 | # Contributing |
2 | 2 |
|
3 | | -We welcome contributions to code, documentation, tests, and files, just create a [GitHub issue](https://github.com/FSIBT/PyMCNP/issues). |
| 3 | +We welcome contributions to code, documentation, tests, and files, |
| 4 | +just create a [GitHub issue](https://github.com/FSIBT/PyMCNP/issues). |
4 | 5 |
|
5 | 6 | ## Contributing |
6 | 7 |
|
7 | | -PyMCNP source code is accessable for contributions, suggestions, and bug reports on [GitHub](https://github.com/FSIBT/PyMCNP): |
| 8 | +PyMCNP source code is accessable for contributions, suggestions, and |
| 9 | +bug reports on [GitHub](https://github.com/FSIBT/PyMCNP): |
8 | 10 |
|
9 | 11 | # Installing |
10 | 12 | git clone https://github.com/FSIBT/PyMCNP |
11 | 13 | cd PyMCNP |
12 | | - pip install -e . |
| 14 | + pip install -e .[dev] |
13 | 15 |
|
14 | 16 | # Running |
15 | 17 | pymcnp |
16 | 18 |
|
17 | | -To contribute, use [pre-commit](https://pre-commit.com) and [ruff](https://docs.astral.sh/ruff/): |
| 19 | +To contribute, use [pre-commit](https://pre-commit.com) and |
| 20 | +[ruff](https://docs.astral.sh/ruff/). These will be automatically |
| 21 | +included when using the optional _dev_ dependency. |
18 | 22 |
|
19 | 23 | # Installing |
20 | | - pip install pre-commit ruff |
21 | 24 | cd PyMCNP |
22 | 25 | pre-commit install |
23 | 26 |
|
24 | | - # Running |
25 | | - pre-commit |
26 | | - |
27 | 27 | ## Testing |
28 | 28 |
|
29 | | -To run the PyMCNP test suite, after cloning the PyMCNP GitHub repository, use the following commands to install [pytest](https://docs.pytest.org/en/stable/) with [pytest-cov](https://pytest-cov.readthedocs.io/en/latest/) inside the PyMCNP directory: |
| 29 | +To run the PyMCNP test suite, after cloning the PyMCNP GitHub |
| 30 | +repository, use the following commands to install |
| 31 | +[pytest](https://docs.pytest.org/en/stable/) with |
| 32 | +[pytest-cov](https://pytest-cov.readthedocs.io/en/latest/) inside the |
| 33 | +PyMCNP directory. This can be done automatically using the _test_ |
| 34 | +dependency. By default coverage and testmon will be used with pytest. |
30 | 35 |
|
31 | 36 | # Installing |
32 | | - pip install pytest-cov |
33 | 37 | cd PyMCNP |
| 38 | + pip install -e .[test] |
34 | 39 | python -m pytest |
35 | 40 |
|
36 | 41 | # Running |
37 | 42 | pytest --cov --cov-report term-missing:skip-covered |
38 | 43 |
|
39 | 44 | ## Documenting |
40 | 45 |
|
41 | | -To rebuild the documentation using [Sphinx](https://www.sphinx-doc.org/en/master/) and [Napolean](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html): |
| 46 | +To rebuild the documentation using |
| 47 | +[Sphinx](https://www.sphinx-doc.org/en/master/) and |
| 48 | +[Napolean](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html). This |
| 49 | +can be done automatically using the _doc_ dependency. |
42 | 50 |
|
43 | 51 | # Installing |
44 | | - pip install sphinx |
| 52 | + pip install -e .[doc] |
45 | 53 |
|
46 | 54 | # Running |
47 | 55 | cd docs |
|
0 commit comments