Skip to content

Commit 3e93e05

Browse files
committed
README: updated README
1 parent 5f31ee5 commit 3e93e05

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,50 @@
44

55
# PyMCNP
66

7-
PyMCNP supports running [Monte Carlo N-Particle (MCNP) simulations](https://mcnp.lanl.gov/). It parses MCNP files, enabling automation such as parameter scans, creates MCNP geometry visualization using [cadquery](https://cadquery.readthedocs.io/en/latest/), and can run MCNP in parallel across multiple machines (including support for clusters). PyMCNP provides a Python API for MCNP input and output files and a command line interface for interacting with MCNP and MCNP files.
7+
PyMCNP supports running [Monte Carlo N-Particle (MCNP) simulations](https://mcnp.lanl.gov/). It parses MCNP files, enabling automation such as parameter scans, creates MCNP geometry visualization using [pyvista](https://pyvista.org). PyMCNP provides a Python API for MCNP input and output files and a command line interface for interacting with MCNP and MCNP files.
88

99
Find more information on [ReadTheDocs](https://pymcnp.readthedocs.io).
1010

1111
## Installation
1212

13-
PyMCNP is available on [PyPI](https://pypi.org/project/pymcnp/) and can be `pip installed`.
13+
PyMCNP is available on [PyPI](https://pypi.org/project/pymcnp/) and can be "pip installed":
1414

1515
pip install pymcnp
1616

1717
## Contributing
1818

19-
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:
19+
PyMCNP source code is accessable for contributions, suggestions, and bug reports on [GitHub](https://github.com/FSIBT/PyMCNP):
2020

21+
# Installing
2122
git clone https://github.com/FSIBT/PyMCNP
2223
cd PyMCNP
2324
pip install -e .
2425

26+
# Running
27+
pymcnp
2528

26-
If you plan to contribute, you should also enable `pre-commit`:
29+
To contribute, use [pre-commit](https://pre-commit.com) and [ruff](https://docs.astral.sh/ruff/):
2730

28-
pip install pre-commit
29-
# cd into repo
31+
# Installing
32+
pip install pre-commit ruff
33+
cd PyMCNP
3034
pre-commit install
3135

32-
from within the top level directory in the git repository.
33-
34-
## Testings
35-
36-
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+
# Running
37+
pre-commit
3738

38-
pip install pytest
39+
## Testing
3940

40-
After instaling `pytest`, test the `pymcnp` package by calling the following commands inside the PyMCNP directory:
41+
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:
4142

43+
# Installing
44+
pip install pytest-cov
4245
cd PyMCNP
4346
python -m pytest
4447

45-
## Metaprogramming
46-
47-
To regenerate the autogenerated, run the following Python script:
48-
49-
python3 src/pymcnp/_text.py
48+
# Running
49+
pytest --cov --cov-report term-missing:skip-covered
5050

5151
## Copyright and License
5252

53-
For copyright and license infromation, see the `COPYRIGHT` and `LICENSE` files in the top level directory.
53+
For copyright and license information, see the `COPYRIGHT` and `LICENSE` files in the top level directory.

0 commit comments

Comments
 (0)