You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/contributing.md
+15-6
Original file line number
Diff line number
Diff line change
@@ -8,31 +8,40 @@ The best way to connect with us is to create a github issue.
8
8
9
9
## Installing
10
10
11
-
PyMCNP source code is accessable for contributions, suggestions, and bug reports on [GitHub](https://github.com/FSIBT/PyMCNP). The following command downloads PyMCNP source code and installs `pymcnp` and its dependencies in editable mode:
11
+
PyMCNP source code is accessable for contributions, suggestions, and
12
+
bug reports on [GitHub](https://github.com/FSIBT/PyMCNP). The
13
+
following command downloads PyMCNP source code and installs `pymcnp`
14
+
and its dependencies in editable mode:
12
15
13
16
git clone https://github.com/FSIBT/PyMCNP
14
17
cd PyMCNP
15
-
pip install -e .
18
+
pip install -e .[docs]
16
19
17
20
## Code formatting, pre-commit, etc.
18
21
19
-
If you plan to contribute, you should also enable `pre-commit`
22
+
If you plan to contribute, you should also enable [pre-commit](https://pre-commit.com/):
20
23
21
24
pip install pre-commit
22
25
# cd into repo
23
26
pre-commit install
24
27
25
-
from within the top level directory in the git repository. Pre-commit will ensure that the code is formatted using ruff and that it will match the coding style in our repository.
28
+
from within the top level directory in the git repository. Pre-commit
29
+
will ensure that the code is formatted using ruff and that it will
30
+
match the coding style in our repository.
26
31
27
32
We are happy to receive pull requests on github.
28
33
29
34
## Testings
30
35
31
-
To run the PyMCNP test suite, after clone the PyMCNP GitHub repository, use the following commands to install Pytest ([Docs](https://docs.pytest.org/en/stable/)) inside the PyMCNP directory:
36
+
To run the PyMCNP test suite, after clone the PyMCNP GitHub
37
+
repository, use the following commands to install Pytest
38
+
([Docs](https://docs.pytest.org/en/stable/)) inside the PyMCNP
39
+
directory:
32
40
33
41
pip install pytest
34
42
35
-
After instaling `pytest`, test the `pymcnp` package by calling the following commands inside the PyMCNP directory:
43
+
After instaling `pytest`, test the `pymcnp` package by calling the
Copy file name to clipboardExpand all lines: docs/source/installation.md
+15-2
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,27 @@ PyMCNP is available on [PyPI](https://pypi.org/project/pymcnp/) and can be `pip
6
6
7
7
pip install pymcnp
8
8
9
+
## Latest Version
10
+
11
+
The latest pre-release version can be installed directly from Github:
12
+
13
+
pip install git+https://github.com/FSIBT/PyMCNP
9
14
10
15
## Developer Version
11
16
12
-
PyMCNP source code is accessable for contributions, suggestions, and bug reports on [GitHub](https://github.com/FSIBT/PyMCNP). The following command downloads PyMCNP source code and installs `pymcnp` and its dependencies in editable mode:
17
+
PyMCNP source code is accessable for contributions, suggestions, and
18
+
bug reports on [GitHub](https://github.com/FSIBT/PyMCNP). The
19
+
following command downloads PyMCNP source code and installs `pymcnp`
20
+
and its dependencies in editable mode:
13
21
14
22
git clone https://github.com/FSIBT/PyMCNP
15
23
cd PyMCNP
16
24
pip install -e .
17
25
18
26
19
-
If you plan to contribute, please also check out the Contribution guidelines.
27
+
To also be able to build the documentation, you should uses
28
+
29
+
pip install -e .[docs]
30
+
31
+
If you plan to contribute, please also check out the [Contribution](contributing.md)
0 commit comments