Skip to content

Commit 75216da

Browse files
committed
inp: removed Data.py
1 parent ec38576 commit 75216da

File tree

2,237 files changed

+33402
-33609
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,237 files changed

+33402
-33609
lines changed

docs/source/cli.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,70 @@
11
# PyMCNP CLI
22

33
PyMCNP provides tools for formatting MCNP files, visualizing MCNP geometries, and running
4-
MCNP simulations using the ``pymcnp`` CLI.
4+
MCNP simulations using the `pymcnp` CLI.
55

66
## Manual Pages
77

8-
The manual page for ``pymcnp``:
8+
The manual page for `pymcnp`:
99

1010
```{eval-rst}
1111
.. literalinclude:: ../../src/pymcnp/_cli/main.py
12-
:language: python
12+
:language: text
1313
:start-after: """
1414
:end-before: """
1515
```
1616

1717
### Check
1818

19-
The manual page for ``pymcnp check``:
19+
The manual page for `pymcnp check`:
2020

2121
```{eval-rst}
2222
.. literalinclude:: ../../src/pymcnp/_cli/check.py
23-
:language: python
23+
:language: text
2424
:start-after: """
2525
:end-before: """
2626
```
2727

2828
### Convert
2929

30-
The manual page for ``pymcnp convert``:
30+
The manual page for `pymcnp convert`:
3131

3232
```{eval-rst}
3333
.. literalinclude:: ../../src/pymcnp/_cli/convert.py
34-
:language: python
34+
:language: text
3535
:start-after: """
3636
:end-before: """
3737
```
3838

3939
### Plot
4040

41-
The manual page for ``pymcnp plot``:
41+
The manual page for `pymcnp plot`:
4242

4343
```{eval-rst}
4444
.. literalinclude:: ../../src/pymcnp/_cli/plot.py
45-
:language: python
45+
:language: text
4646
:start-after: """
4747
:end-before: """
4848
```
4949

5050
### Run
5151

52-
The manual page for ``pymcnp run``:
52+
The manual page for `pymcnp run`:
5353

5454
```{eval-rst}
5555
.. literalinclude:: ../../src/pymcnp/_cli/run.py
56-
:language: python
56+
:language: text
5757
:start-after: """
5858
:end-before: """
5959
```
6060

6161
### Visualize
6262

63-
The manual page for ``pymcnp visualize``:
63+
The manual page for `pymcnp visualize`:
6464

6565
```{eval-rst}
6666
.. literalinclude:: ../../src/pymcnp/_cli/visualize.py
67-
:language: python
67+
:language: text
6868
:start-after: """
6969
:end-before: """
7070
```

docs/source/examples/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Code:
5353

5454
Output:
5555

56-
Create ``Inp``
56+
Create `Inp`
5757

5858
1 21 0.5 11
5959
2 22 0.5 12:11

docs/source/examples/do.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# "Do" Examples
22

3-
PyMCNP enables common workflows using ``pyvista``, ``pandas``, ``subprocesss``, ``matplotlib``, and ``difflib``.
3+
PyMCNP enables common workflows using `pyvista`, `pandas`, `subprocesss`, `matplotlib`, and `difflib`.
44

55
## Checking INP Files
66

docs/source/pymcnp.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ MCNP. This package supports INP, OUTP, PTRAC, and MESHTAL parsing using subpacka
2929

3030
## AST Classes
3131

32-
PyMCNP represents MCNP files using the ``Inp``, ``Meshtal``, and ``Ptrac`` AST classes and
33-
``inp``, ``meshtal``, and ``ptrac`` subpackages. These classes have important methods for translating PyMCNP and MCNP:
32+
PyMCNP represents MCNP files using the `Inp`, `Meshtal`, and `Ptrac` AST classes and
33+
`inp`, `meshtal`, and `ptrac` subpackages. These classes have important methods for translating PyMCNP and MCNP:
3434

35-
* ``from_mcnp``. Parses MCNP source, checking for syntax and semantic errors.
36-
* ``to_mcnp``. Generates MCNP source from PyMCNP objects, reformatting.
37-
* ``from_file``. Parses MCNP file.
38-
* ``to_file``. Generates MCNP file from PyMCNP objects.
35+
* `from_mcnp`. Parses MCNP source, checking for syntax and semantic errors.
36+
* `to_mcnp`. Generates MCNP source from PyMCNP objects, reformatting.
37+
* `from_file`. Parses MCNP file.
38+
* `to_file`. Generates MCNP file from PyMCNP objects.
3939

40-
### ``Inp`` Class
40+
### `Inp` Class
4141

4242
```{eval-rst}
4343
.. autoclass:: pymcnp.Inp
@@ -47,7 +47,7 @@ PyMCNP represents MCNP files using the ``Inp``, ``Meshtal``, and ``Ptrac`` AST c
4747

4848
[inp subpackage](pymcnp/inp)
4949

50-
### ``Outp`` Class
50+
### `Outp` Class
5151

5252
```{eval-rst}
5353
.. autoclass:: pymcnp.Outp
@@ -57,7 +57,7 @@ PyMCNP represents MCNP files using the ``Inp``, ``Meshtal``, and ``Ptrac`` AST c
5757

5858
[meshtal subpackage](pymcnp/outp)
5959

60-
### ``Ptrac`` Class
60+
### `Ptrac` Class
6161

6262
```{eval-rst}
6363
.. autoclass:: pymcnp.Ptrac
@@ -67,7 +67,7 @@ PyMCNP represents MCNP files using the ``Inp``, ``Meshtal``, and ``Ptrac`` AST c
6767

6868
[ptrac subpackage](pymcnp/ptrac)
6969

70-
### ``Meshtal`` Class
70+
### `Meshtal` Class
7171

7272
```{eval-rst}
7373
.. autoclass:: pymcnp.Meshtal
@@ -79,89 +79,89 @@ PyMCNP represents MCNP files using the ``Inp``, ``Meshtal``, and ``Ptrac`` AST c
7979

8080
## Doer Classes
8181

82-
The ``*Filter`` and ``*Processor`` classes help handle large ``Meshtal`` and ``Ptrac`` using generators.
83-
``PtracFilter`` and ``MeshtalFilter`` have overridable methods for filtering data, ``PtracProcessor``
84-
and ``MeshtalProcessor`` have overridable methods for processing data, and all can be run:
82+
The `*Filter` and `*Processor` classes help handle large `Meshtal` and `Ptrac` using generators.
83+
`PtracFilter` and `MeshtalFilter` have overridable methods for filtering data, `PtracProcessor`
84+
and `MeshtalProcessor` have overridable methods for processing data, and all can be run:
8585

86-
* ``check_*``. Returns ``True``/``False`` if data should be kept/removed.
87-
* ``process_*``. Operates with side effects on data.
88-
* ``run``. Runs the filter or processor.
86+
* `check_*`. Returns `True`/`False` if data should be kept/removed.
87+
* `process_*`. Operates with side effects on data.
88+
* `run`. Runs the filter or processor.
8989

90-
### ``MeshtalFilter`` Class
90+
### `MeshtalFilter` Class
9191

9292
```{eval-rst}
9393
.. autoclass:: pymcnp.MeshtalFilter
9494
:members:
9595
:inherited-members:
9696
```
9797

98-
### ``PtracFilter`` Class
98+
### `PtracFilter` Class
9999

100100
```{eval-rst}
101101
.. autoclass:: pymcnp.PtracFilter
102102
:members:
103103
:inherited-members:
104104
```
105105

106-
### ``MeshtalProcessor`` Class
106+
### `MeshtalProcessor` Class
107107

108108
```{eval-rst}
109109
.. autoclass:: pymcnp.MeshtalProcessor
110110
:members:
111111
:inherited-members:
112112
```
113113

114-
### ``PtracProcessor`` Class
114+
### `PtracProcessor` Class
115115

116116
```{eval-rst}
117117
.. autoclass:: pymcnp.PtracProcessor
118118
:members:
119119
:inherited-members:
120120
```
121121

122-
### ``Check`` Class
122+
### `Check` Class
123123

124-
``Check`` compares and fixes MCNP files, using ``difflib``,
124+
`Check` compares and fixes MCNP files, using `difflib`,
125125

126126
```{eval-rst}
127127
.. autoclass:: pymcnp.Check
128128
:members:
129129
:inherited-members:
130130
```
131131

132-
### ``Convert`` Class
132+
### `Convert` Class
133133

134-
``Convert`` converts OUTP files to csv or parquet files, using ``pandas``.
134+
`Convert` converts OUTP files to csv or parquet files, using `pandas`.
135135

136136
```{eval-rst}
137137
.. autoclass:: pymcnp.Convert
138138
:members:
139139
:inherited-members:
140140
```
141141

142-
### ``Plot`` Class
142+
### `Plot` Class
143143

144-
``Plot`` plots OUTP files, using ``matplotlib``.
144+
`Plot` plots OUTP files, using `matplotlib`.
145145

146146
```{eval-rst}
147147
.. autoclass:: pymcnp.Plot
148148
:members:
149149
:inherited-members:
150150
```
151151

152-
### ``Run`` Class
152+
### `Run` Class
153153

154-
``Run`` runs MCNP simulations in parallel, using ``subprocess``.
154+
`Run` runs MCNP simulations in parallel, using `subprocess`.
155155

156156
```{eval-rst}
157157
.. autoclass:: pymcnp.Run
158158
:members:
159159
:inherited-members:
160160
```
161161

162-
### ``Visualize`` Class
162+
### `Visualize` Class
163163

164-
``Visualize`` visualizes INP surfaces and cell geometries, using ``pyvista``.
164+
`Visualize` visualizes INP surfaces and cell geometries, using `pyvista`.
165165

166166
```{eval-rst}
167167
.. autoclass:: pymcnp.Visualize

docs/source/pymcnp/errors.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
1-
# ``pymcnp.errors`` Subpackage
1+
# `pymcnp.errors` Subpackage
22

3-
``pymcnp.errors`` contains wrappers for Python exceptions and errors codes.
3+
`pymcnp.errors` contains wrappers for Python exceptions and errors codes.
44

55
## Error Classes
66

77
PyMCNP represents errors with error classes.
88

9-
### ``CliError`` Class
9+
### `CliError` Class
1010

1111
```{eval-rst}
1212
.. autoclass:: pymcnp.errors.CliError
1313
:members:
1414
```
1515

16-
### ``InpError`` Class
16+
### `InpError` Class
1717

1818
```{eval-rst}
1919
.. autoclass:: pymcnp.errors.InpError
2020
:members:
2121
```
2222

23-
### ``MeshtalError`` Class
23+
### `MeshtalError` Class
2424

2525
```{eval-rst}
2626
.. autoclass:: pymcnp.errors.MeshtalError
2727
:members:
2828
```
2929

30-
### ``OutpError`` Class
30+
### `OutpError` Class
3131

3232
```{eval-rst}
3333
.. autoclass:: pymcnp.errors.OutpError
3434
:members:
3535
```
3636

37-
### ``PtracError`` Class
37+
### `PtracError` Class
3838

3939
```{eval-rst}
4040
.. autoclass:: pymcnp.errors.PtracError
4141
:members:
4242
```
4343

44-
### ``TypesError`` Class
44+
### `TypesError` Class
4545

4646
```{eval-rst}
4747
.. autoclass:: pymcnp.errors.TypesError
@@ -52,42 +52,42 @@ PyMCNP represents errors with error classes.
5252

5353
PyMCNP represents error codes with code classes.
5454

55-
### ``CliCode`` Class
55+
### `CliCode` Class
5656

5757
```{eval-rst}
5858
.. autoclass:: pymcnp.errors.CliCode
5959
:members:
6060
```
6161

62-
### ``InpCode`` Class
62+
### `InpCode` Class
6363

6464
```{eval-rst}
6565
.. autoclass:: pymcnp.errors.InpCode
6666
:members:
6767
```
6868

69-
### ``MeshtalCode`` Class
69+
### `MeshtalCode` Class
7070

7171
```{eval-rst}
7272
.. autoclass:: pymcnp.errors.MeshtalCode
7373
:members:
7474
```
7575

76-
### ``OutpCode`` Class
76+
### `OutpCode` Class
7777

7878
```{eval-rst}
7979
.. autoclass:: pymcnp.errors.OutpCode
8080
:members:
8181
```
8282

83-
### ``PtracCode`` Class
83+
### `PtracCode` Class
8484

8585
```{eval-rst}
8686
.. autoclass:: pymcnp.errors.PtracCode
8787
:members:
8888
```
8989

90-
### ``TypesCode`` Class
90+
### `TypesCode` Class
9191

9292
```{eval-rst}
9393
.. autoclass:: pymcnp.errors.TypesCode

0 commit comments

Comments
 (0)