Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix typo for word boundaries in doc #2824

Merged
merged 3 commits into from
Oct 8, 2024

Conversation

RyanGroneck
Copy link
Contributor

@RyanGroneck RyanGroneck commented Sep 20, 2024

📝 Description

Type: 📝 documentation

Write a complete description of your changes, including the necessary context or any piece of information required to understand your work.

fixed typos discovered by codespell and added my info to mailmap

Also, link issues affected by this pull request by using the keywords: close, closes, closed, fix, fixes, fixed, resolve, resolves or resolved.

📌 Resources

Examples, notebooks, and links to useful references.

🚦 Testing

How did you test these changes?

  • Testing pipeline
  • Other method (describe)
  • My changes can't be tested (explain why)

☑️ Checklist

  • I requested two reviewers for this pull request
  • I updated the documentation according to my changes
  • I built the documentation by applying the build_docs label

Note: If you are not allowed to perform any of these actions, ping (@) a contributor.

@tardis-bot
Copy link
Contributor

tardis-bot commented Sep 20, 2024

*beep* *bop*

Hi, human.

The docs workflow has failed

Click here to see the build log.

@tardis-bot
Copy link
Contributor

tardis-bot commented Sep 20, 2024

*beep* *bop*
Hi human,
I ran ruff on the latest commit (3251615).
Here are the outputs produced.
Results can also be downloaded as artifacts here.
Summarised output:

88	I001   	[*] Import block is un-sorted or un-formatted
69	F401   	[*] `astropy.constants` imported but unused
40	W291   	[*] Trailing whitespace
38	D202   	[*] No blank lines allowed after function docstring (found 1)
25	W293   	[*] Blank line contains whitespace
21	G004   	[ ] Logging statement uses f-string
16	E402   	[ ] Module level import not at top of cell
16	F821   	[ ] Undefined name `basestring`
13	RET505 	[ ] Unnecessary `elif` after `return` statement
13	UP008  	[*] Use `super()` instead of `super(__class__, self)`
12	INP001 	[ ] File `tardis/analysis/opacities.py` is part of an implicit namespace package. Add an `__init__.py`.
12	E999   	[ ] SyntaxError: Expected a statement
12	UP015  	[*] Unnecessary open mode parameters
11	UP004  	[*] Class `ConvergencePlots` inherits from `object`
10	S108   	[ ] Probable insecure usage of temporary file or directory: "/tmp/full_example.hdf"
10	F811   	[*] Redefinition of unused `Path` from line 1
6	UP031  	[*] Use format specifiers instead of percent format
6	UP032  	[*] Use f-string instead of `format` call
5	RET506 	[ ] Unnecessary `elif` after `raise` statement
4	B011   	[*] Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`
4	ICN001 	[ ] `pandas` should be imported as `pd`
4	PT015  	[ ] Assertion always fails, replace with `pytest.fail()`
4	D409   	[*] Section underline should match the length of its name ("Parameters")
4	D411   	[*] Missing blank line before section ("Parameters")
4	D412   	[*] No blank lines allowed between a section header and its content ("Parameters")
4	PLR1711	[*] Useless `return` statement at end of function
3	C408   	[*] Unnecessary `dict` call (rewrite as a literal)
3	PIE790 	[*] Unnecessary `pass` statement
3	E712   	[*] Avoid equality comparisons to `True`; use `if specific_log_level:` for truth checks
3	D209   	[*] Multi-line docstring closing quotes should be on a separate line
3	UP024  	[*] Replace aliased errors with `OSError`
2	C403   	[*] Unnecessary `list` comprehension (rewrite as a `set` comprehension)
2	C416   	[*] Unnecessary `list` comprehension (rewrite using `list()`)
2	PT013  	[ ] Incorrect import of `pytest`; use `import pytest` instead
2	N812   	[ ] Lowercase `__path__` imported as non-lowercase `TARDIS_PATH`
2	E722   	[ ] Do not use bare `except`
2	W605   	[*] Invalid escape sequence: `\A`
1	ANN204 	[ ] Missing return type annotation for special method `__getitem__`
1	S605   	[ ] Starting a process with a shell: seems safe, but may be changed in the future; consider rewriting without `shell`
1	B009   	[*] Do not call `getattr` with a constant attribute value. It is not any safer than normal property access.
1	B017   	[ ] `pytest.raises(Exception)` should be considered evil
1	B018   	[ ] Found useless expression. Either assign it to a variable or remove it.
1	C405   	[*] Unnecessary `list` literal (rewrite as a `set` literal)
1	C414   	[*] Unnecessary `list` call within `set()`
1	FA100  	[ ] Add `from __future__ import annotations` to simplify `typing.Tuple`
1	ISC003 	[ ] Explicitly concatenated string should be implicitly concatenated
1	G001   	[ ] Logging statement uses `str.format`
1	PIE808 	[*] Unnecessary `start` argument in `range`
1	PT014  	[*] Duplicate of test case at index 1 in `@pytest_mark.parametrize`
1	PT021  	[ ] Use `yield` instead of `request.addfinalizer`
1	RET508 	[ ] Unnecessary `else` after `break` statement
1	SIM210 	[*] Remove unnecessary `True if ... else False`
1	PTH117 	[ ] `os.path.isabs()` should be replaced by `Path.is_absolute()`
1	FLY002 	[*] Consider `"\n---\n"` instead of string join
1	NPY201 	[ ] `np.recfromtxt` will be removed in NumPy 2.0. Use `np.genfromtxt` instead.
1	N999   	[ ] Invalid module name: 'test_HDFWriter'
1	E401   	[*] Multiple imports on one line
1	E701   	[ ] Multiple statements on one line (colon)
1	E703   	[*] Statement ends with an unnecessary semicolon
1	E713   	[*] Test for membership should be `not in`
1	D406   	[*] Section name should end with a newline ("Returns")
1	D407   	[*] Missing dashed underline after section ("Returns")
1	F403   	[ ] `from tardis.grid.base import *` used; unable to detect undefined names
1	F541   	[*] f-string without any placeholders
1	UP028  	[*] Replace `yield` over `for` loop with `yield from`
1	UP030  	[*] Use implicit references for positional format fields
1	UP034  	[*] Avoid extraneous parentheses

Complete output(might be large):

.github/workflows/benchmarks.yml:3:4: E999 SyntaxError: Expected an expression
.github/workflows/benchmarks.yml:20:5: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:82:49: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:112:81: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:113:54: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:200:1: W293 [*] Blank line contains whitespace
.github/workflows/benchmarks.yml:219:22: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:220:170: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:222:84: W291 [*] Trailing whitespace
.github/workflows/benchmarks.yml:239:1: W293 [*] Blank line contains whitespace
.github/workflows/pre-release.yml:7:4: E999 SyntaxError: Expected an expression
.github/workflows/release.yml:7:4: E999 SyntaxError: Expected an expression
.github/workflows/release.yml:16:7: E701 Multiple statements on one line (colon)
.github/workflows/tests.yml:7:4: E999 SyntaxError: Expected an expression
.mailmap:1:38: E999 SyntaxError: Expected an expression
docs/contributing/development/known_projects.inc:1:1: E999 SyntaxError: Expected a statement
docs/contributing/tools/hdf_writer.ipynb:cell 3:9:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/hdf_writer.ipynb:cell 8:3:11: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
docs/contributing/tools/profiling/profiling_example.ipynb:cell 3:3:1: I001 [*] Import block is un-sorted or un-formatted
docs/contributing/tools/profiling/profiling_example.ipynb:cell 3:3:20: F401 [*] `tardis.run_tardis` imported but unused
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:1:8: F401 [*] `tardis` imported but unused
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:5:38: F401 [*] `tardis.io.atom_data.base.AtomData` imported but unused
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:7:20: F811 [*] Redefinition of unused `run_tardis` from cell 2, line 2
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:11:1: E402 Module level import not at top of cell
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:11:1: I001 [*] Import block is un-sorted or un-formatted
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:12:1: E402 Module level import not at top of cell
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:13:1: E402 Module level import not at top of cell
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:13:30: F401 [*] `astropy.units` imported but unused
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:14:1: E402 Module level import not at top of cell
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:15:1: E402 Module level import not at top of cell
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 2:16:1: E402 Module level import not at top of cell
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:2:5: D202 [*] No blank lines allowed after function docstring (found 1)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:8:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:12:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:17:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:22:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:24:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:26:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:32:21: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:35:5: D202 [*] No blank lines allowed after function docstring (found 1)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:37:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:44:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:54:5: D202 [*] No blank lines allowed after function docstring (found 1)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:57:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:63:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:68:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 4:75:5: RET505 Unnecessary `elif` after `return` statement
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:1:32: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:2:35: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:3:37: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:4:41: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:5:31: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:6:31: W291 [*] Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:8:5: D202 [*] No blank lines allowed after function docstring (found 1)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:11:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:13:112: W291 Trailing whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:15:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:49:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:54:33: UP032 [*] Use f-string instead of `format` call
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:56:33: UP032 [*] Use f-string instead of `format` call
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 7:57:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 8:9:6: UP015 [*] Unnecessary open mode parameters
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 8:12:6: UP015 [*] Unnecessary open mode parameters
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 8:16:19: C416 Unnecessary `list` comprehension (rewrite using `list()`)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 8:17:23: C416 Unnecessary `list` comprehension (rewrite using `list()`)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 9:2:5: D202 [*] No blank lines allowed after function docstring (found 1)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 9:4:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 9:11:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 10:2:5: D202 [*] No blank lines allowed after function docstring (found 1)
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 10:4:1: W293 Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 10:18:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 10:30:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 10:44:1: W293 [*] Blank line contains whitespace
docs/contributing/tools/profiling/tardis_profiling_threads.ipynb:cell 10:45:43: UP032 [*] Use f-string instead of `format` call
docs/io/configuration/components/models/converters/arepo_to_tardis.ipynb:cell 6:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/configuration/components/models/converters/arepo_to_tardis.ipynb:cell 6:1:17: F401 [*] `numpy` imported but unused
docs/io/configuration/components/models/converters/arepo_to_tardis.ipynb:cell 6:4:8: F401 [*] `json` imported but unused
docs/io/configuration/components/models/csvy_full_rad.csvy:1:4: E999 SyntaxError: Expected an expression
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 2:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 7:2:74: W291 [*] Trailing whitespace
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 14:1:47: W291 [*] Trailing whitespace
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 14:4:46: E703 [*] Statement ends with an unnecessary semicolon
docs/io/grid/how_to_TardisGridTutorial.ipynb:cell 15:2:55: W291 [*] Trailing whitespace
docs/io/optional/tutorial_callback_example.ipynb:cell 5:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/optional/tutorial_callback_example.ipynb:cell 5:5:1: E402 Module level import not at top of cell
docs/io/optional/tutorial_callback_example.ipynb:cell 5:6:1: E402 Module level import not at top of cell
docs/io/optional/tutorial_callback_example.ipynb:cell 5:12:39: W291 [*] Trailing whitespace
docs/io/optional/tutorial_callback_example.ipynb:cell 9:5:29: W291 [*] Trailing whitespace
docs/io/optional/tutorial_callback_example.ipynb:cell 9:9:39: W291 [*] Trailing whitespace
docs/io/optional/tutorial_callback_example.ipynb:cell 14:6:65: W291 [*] Trailing whitespace
docs/io/optional/tutorial_callback_example.ipynb:cell 14:10:39: W291 [*] Trailing whitespace
docs/io/optional/tutorial_logging_configuration.ipynb:cell 31:1:21: W291 [*] Trailing whitespace
docs/io/output/how_to_physical_quantities.ipynb:cell 4:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/output/how_to_plasma_graph.ipynb:cell 3:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/output/how_to_plasma_graph.ipynb:cell 19:1:6: UP015 [*] Unnecessary open mode parameters
docs/io/output/how_to_rpacket_tracking.ipynb:cell 12:1:62: W291 [*] Trailing whitespace
docs/io/output/how_to_to_hdf.ipynb:cell 5:1:19: S108 Probable insecure usage of temporary file or directory: "/tmp/full_example.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 7:3:20: S108 Probable insecure usage of temporary file or directory: "/tmp/full_example.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 14:1:26: S108 Probable insecure usage of temporary file or directory: "/tmp/plasma_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 15:1:8: ICN001 `pandas` should be imported as `pd`
docs/io/output/how_to_to_hdf.ipynb:cell 15:3:31: S108 Probable insecure usage of temporary file or directory: "/tmp/plasma_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 17:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/output/how_to_to_hdf.ipynb:cell 17:2:26: S108 Probable insecure usage of temporary file or directory: "/tmp/plasma_input_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 18:1:8: ICN001 `pandas` should be imported as `pd`
docs/io/output/how_to_to_hdf.ipynb:cell 18:3:37: S108 Probable insecure usage of temporary file or directory: "/tmp/plasma_input_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 20:1:36: S108 Probable insecure usage of temporary file or directory: "/tmp/model_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 21:1:8: ICN001 `pandas` should be imported as `pd`
docs/io/output/how_to_to_hdf.ipynb:cell 21:3:30: S108 Probable insecure usage of temporary file or directory: "/tmp/model_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 23:1:29: S108 Probable insecure usage of temporary file or directory: "/tmp/transport_output.hdf"
docs/io/output/how_to_to_hdf.ipynb:cell 24:1:8: ICN001 `pandas` should be imported as `pd`
docs/io/output/how_to_to_hdf.ipynb:cell 24:3:34: S108 Probable insecure usage of temporary file or directory: "/tmp/transport_output.hdf"
docs/io/visualization/how_to_generating_widgets.ipynb:cell 5:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/visualization/how_to_generating_widgets.ipynb:cell 5:3:5: F401 [*] `tardis.visualization.shell_info_from_hdf` imported but unused
docs/io/visualization/how_to_sdec_plot.ipynb:cell 2:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/visualization/how_to_sdec_plot.ipynb:cell 29:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/visualization/tutorial_convergence_plot.ipynb:cell 9:4:28: W291 [*] Trailing whitespace
docs/io/visualization/tutorial_convergence_plot.ipynb:cell 12:29:1: W293 [*] Blank line contains whitespace
docs/io/visualization/tutorial_convergence_plot.ipynb:cell 13:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/io/visualization/tutorial_montecarlo_packet_visualization.ipynb:cell 5:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/multiindex_isotope_decay_data.ipynb:cell 1:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/multiindex_isotope_decay_data.ipynb:cell 1:2:21: F401 [*] `pathlib.Path` imported but unused
docs/multiindex_isotope_decay_data.ipynb:cell 7:5:70: W291 [*] Trailing whitespace
docs/physics/nlte/nlte_rates.ipynb:cell 1:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/nlte/nlte_rates.ipynb:cell 1:1:32: F401 [*] `tardis.plasma.nlte.nlte_data` imported but unused
docs/physics/nlte/nlte_rates.ipynb:cell 1:5:19: F401 [*] `scipy.sparse` imported but unused
docs/physics/setup/model.ipynb:cell 2:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/setup/model.ipynb:cell 25:19:12: F541 [*] f-string without any placeholders
docs/physics/setup/setup_example.ipynb:cell 2:2:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/spectrum/basic.ipynb:cell 3:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/update_and_conv/update_and_conv.ipynb:cell 7:1:1: I001 [*] Import block is un-sorted or un-formatted
docs/physics/update_and_conv/update_and_conv.ipynb:cell 18:1:69: W291 [*] Trailing whitespace
docs/physics/update_and_conv/update_and_conv.ipynb:cell 26:1:50: W291 [*] Trailing whitespace
docs/physics/update_and_conv/update_and_conv.ipynb:cell 31:11:1: E402 Module level import not at top of cell
docs/physics/update_and_conv/update_and_conv.ipynb:cell 31:11:1: I001 [*] Import block is un-sorted or un-formatted
docs/quickstart.ipynb:cell 12:1:39: W291 [*] Trailing whitespace
docs/quickstart.ipynb:cell 12:5:35: W291 [*] Trailing whitespace
docs/quickstart.ipynb:cell 16:10:26: W605 [*] Invalid escape sequence: `\A`
docs/quickstart.ipynb:cell 16:11:40: W605 [*] Invalid escape sequence: `\A`
docs/resources/code_comparison/toy_models/blondin_compare.csvy:1:4: E999 SyntaxError: Expected an expression
docs/resources/code_comparison/toy_models/blondin_compare_01.csvy:1:4: E999 SyntaxError: Expected an expression
docs/resources/code_comparison/toy_models/blondin_compare_06.csvy:1:4: E999 SyntaxError: Expected an expression
tardis/analysis/opacities.py:1:1: INP001 File `tardis/analysis/opacities.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/analysis/opacities.py:1:1: D209 [*] Multi-line docstring closing quotes should be on a separate line
tardis/analysis/opacities.py:3:1: I001 [*] Import block is un-sorted or un-formatted
tardis/analysis/opacities.py:12:26: UP004 [*] Class `opacity_calculator` inherits from `object`
tardis/analysis/opacities.py:225:9: D209 [*] Multi-line docstring closing quotes should be on a separate line
tardis/analysis/opacities.py:274:9: D209 [*] Multi-line docstring closing quotes should be on a separate line
tardis/analysis/opacities.py:282:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/analysis/opacities.py:329:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/analysis/opacities.py:360:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/analysis/opacities.py:388:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/grid/__init__.py:2:41: W291 Trailing whitespace
tardis/grid/__init__.py:3:37: W291 Trailing whitespace
tardis/grid/__init__.py:7:1: F403 `from tardis.grid.base import *` used; unable to detect undefined names
tardis/grid/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/grid/base.py:7:33: F401 [*] `tardis.io.atom_data.AtomData` imported but unused
tardis/grid/base.py:33:5: PLR1711 [*] Useless `return` statement at end of function
tardis/grid/base.py:70:9: PLR1711 [*] Useless `return` statement at end of function
tardis/grid/base.py:147:9: PLR1711 [*] Useless `return` statement at end of function
tardis/grid/tests/test_grid.py:1:1: INP001 File `tardis/grid/tests/test_grid.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/grid/tests/test_grid.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/grid/tests/test_grid.py:8:21: F811 [*] Redefinition of unused `Path` from line 1
tardis/io/atom_data/__init__.py:2:38: W291 Trailing whitespace
tardis/io/atom_data/__init__.py:5:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/atom_data/__init__.py:5:38: F401 `tardis.io.atom_data.base.AtomData` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/io/atom_data/__init__.py:6:51: F401 `tardis.io.atom_data.atom_web_download.download_atom_data` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/io/atom_data/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/atom_data/base.py:198:34: G004 Logging statement uses f-string
tardis/io/atom_data/base.py:263:17: G004 Logging statement uses f-string
tardis/io/atom_data/base.py:267:21: UP030 Use implicit references for positional format fields
tardis/io/atom_data/base.py:267:21: G001 Logging statement uses `str.format`
tardis/io/atom_data/base.py:704:17: G004 Logging statement uses f-string
tardis/io/atom_data/util.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/atom_data/util.py:8:5: F401 [*] `tardis.io.atom_data.atom_web_download.download_atom_data` imported but unused
tardis/io/atom_data/util.py:15:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/atom_data/util.py:37:13: G004 Logging statement uses f-string
tardis/io/atom_data/util.py:44:15: UP024 [*] Replace aliased errors with `OSError`
tardis/io/atom_data/util.py:50:11: UP024 [*] Replace aliased errors with `OSError`
tardis/io/configuration/config_internal.py:1:1: E401 [*] Multiple imports on one line
tardis/io/configuration/config_internal.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/configuration/config_internal.py:6:20: N812 Lowercase `__path__` imported as non-lowercase `TARDIS_PATH`
tardis/io/configuration/config_internal.py:23:13: G004 Logging statement uses f-string
tardis/io/configuration/config_internal.py:36:13: G004 Logging statement uses f-string
tardis/io/configuration/config_internal.py:49:15: UP024 [*] Replace aliased errors with `OSError`
tardis/io/configuration/config_reader.py:53:29: G004 Logging statement uses f-string
tardis/io/configuration/config_reader.py:88:21: C408 Unnecessary `dict` call (rewrite as a literal)
tardis/io/configuration/config_reader.py:112:21: UP008 Use `super()` instead of `super(__class__, self)`
tardis/io/configuration/config_reader.py:117:9: RET505 Unnecessary `else` after `return` statement
tardis/io/configuration/config_reader.py:118:18: UP008 Use `super()` instead of `super(__class__, self)`
tardis/io/configuration/config_reader.py:141:13: RET505 Unnecessary `else` after `return` statement
tardis/io/configuration/config_reader.py:218:29: G004 Logging statement uses f-string
tardis/io/configuration/config_reader.py:450:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/io/configuration/config_validator.py:43:9: UP028 Replace `yield` over `for` loop with `yield from`
tardis/io/configuration/tests/data/tardis_configv1_verysimple.yml:1:26: E999 SyntaxError: Simple statements must be separated by newlines or semicolons
tardis/io/configuration/tests/test_config_reader.py:1:1: INP001 File `tardis/io/configuration/tests/test_config_reader.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/configuration/tests/test_config_reader.py:2:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/configuration/tests/test_config_reader.py:2:8: F401 [*] `os` imported but unused
tardis/io/configuration/tests/test_config_reader.py:3:18: F401 [*] `attr.validate` imported but unused
tardis/io/configuration/tests/test_configuration_namespace.py:1:1: INP001 File `tardis/io/configuration/tests/test_configuration_namespace.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/configuration/tests/test_configuration_namespace.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/logger/__init__.py:2:29: W291 Trailing whitespace
tardis/io/logger/colored_logger.py:83:9: PLR1711 [*] Useless `return` statement at end of function
tardis/io/logger/logger.py:4:63: F401 [*] `tardis.io.logger.colored_logger.formatter_message` imported but unused
tardis/io/logger/logger.py:28:17: UP004 [*] Class `FilterLog` inherits from `object`
tardis/io/logger/logger.py:66:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/logger/logger.py:118:12: E713 [*] Test for membership should be `not in`
tardis/io/logger/montecarlo_tracking.py:2:23: F401 [*] `functools.wraps` imported but unused
tardis/io/logger/montecarlo_tracking.py:63:30: G004 Logging statement uses f-string
tardis/io/logger/montecarlo_tracking.py:64:30: G004 Logging statement uses f-string
tardis/io/logger/tests/test_logging.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/logger/tests/test_logging.py:8:8: F811 [*] Redefinition of unused `pytest` from line 1
tardis/io/logger/tests/test_logging.py:70:16: E712 Avoid equality comparisons to `True`; use `if specific_log_level:` for truth checks
tardis/io/logger/tests/test_logging.py:88:16: E712 Avoid equality comparisons to `True`; use `if specific_log_level:` for truth checks
tardis/io/logger/tests/test_logging.py:110:16: E712 Avoid equality comparisons to `True`; use `if specific_log_level:` for truth checks
tardis/io/model/__init__.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/__init__.py:1:44: F401 `tardis.io.model.readers.stella.read_stella_model` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/io/model/__init__.py:4:44: F401 `tardis.io.model.readers.cmfgen.read_cmfgen_model` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/io/model/readers/arepo.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/arepo.py:19:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/arepo.py:129:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/arepo.py:178:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/arepo.py:256:19: UP032 [*] Use f-string instead of `format` call
tardis/io/model/readers/arepo.py:268:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/arepo.py:384:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/arepo.py:429:25: UP032 [*] Use f-string instead of `format` call
tardis/io/model/readers/arepo.py:432:25: UP032 [*] Use f-string instead of `format` call
tardis/io/model/readers/arepo.py:453:29: UP031 Use format specifiers instead of percent format
tardis/io/model/readers/arepo.py:454:29: UP031 Use format specifiers instead of percent format
tardis/io/model/readers/arepo.py:461:17: FLY002 Consider `"\n---\n"` instead of string join
tardis/io/model/readers/arepo.py:472:35: UP031 Use format specifiers instead of percent format
tardis/io/model/readers/arepo.py:473:31: UP031 Use format specifiers instead of percent format
tardis/io/model/readers/arepo.py:501:29: UP031 Use format specifiers instead of percent format
tardis/io/model/readers/arepo.py:502:25: UP031 Use format specifiers instead of percent format
tardis/io/model/readers/arepo.py:537:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/arepo.py:707:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/artis.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/artis.py:7:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/base.py:25:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/blondin_toymodel.py:31:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/blondin_toymodel.py:94:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/cmfgen.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/cmfgen.py:4:21: F401 [*] `pathlib.Path` imported but unused
tardis/io/model/readers/cmfgen.py:27:5: D412 [*] No blank lines allowed between a section header and its content ("Parameters")
tardis/io/model/readers/cmfgen_deprecated.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/cmfgen_deprecated.py:73:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/csvy.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/csvy.py:100:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/model/readers/generic_readers.py:1:21: F401 [*] `pathlib.Path` imported but unused
tardis/io/model/readers/generic_readers.py:21:6: FA100 Add `from __future__ import annotations` to simplify `typing.Tuple`
tardis/io/model/readers/generic_readers.py:48:12: NPY201 `np.recfromtxt` will be removed in NumPy 2.0. Use `np.genfromtxt` instead.
tardis/io/model/readers/stella.py:32:5: D412 [*] No blank lines allowed between a section header and its content ("Parameters")
tardis/io/model/readers/stella.py:53:17: RET508 Unnecessary `else` after `break` statement
tardis/io/model/readers/tests/test_arepo_parser.py:1:1: INP001 File `tardis/io/model/readers/tests/test_arepo_parser.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/model/readers/tests/test_arepo_parser.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/tests/test_arepo_parser.py:16:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/tests/test_arepo_parser.py:48:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/tests/test_arepo_parser.py:59:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/tests/test_arepo_parser.py:89:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/tests/test_arepo_parser.py:99:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/tests/test_arepo_parser.py:109:10: UP015 [*] Unnecessary open mode parameters
tardis/io/model/readers/tests/test_ascii_readers.py:1:1: INP001 File `tardis/io/model/readers/tests/test_ascii_readers.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/model/readers/tests/test_ascii_readers.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/tests/test_ascii_readers.py:3:20: F401 [*] `tardis.io` imported but unused
tardis/io/model/readers/tests/test_ascii_readers.py:10:17: F401 [*] `numpy` imported but unused
tardis/io/model/readers/tests/test_ascii_readers.py:12:21: F401 [*] `pathlib.Path` imported but unused
tardis/io/model/readers/tests/test_cmfgen_reader.py:1:1: INP001 File `tardis/io/model/readers/tests/test_cmfgen_reader.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/model/readers/tests/test_cmfgen_reader.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/tests/test_cmfgen_reader.py:5:1: PT013 Incorrect import of `pytest`; use `import pytest` instead
tardis/io/model/readers/tests/test_cmfgen_reader.py:6:30: F401 [*] `astropy.units` imported but unused
tardis/io/model/readers/tests/test_csvy_reader.py:1:1: INP001 File `tardis/io/model/readers/tests/test_csvy_reader.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/model/readers/tests/test_csvy_reader.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/tests/test_csvy_reader.py:5:38: F401 [*] `jsonschema.exceptions` imported but unused
tardis/io/model/readers/tests/test_csvy_reader.py:8:30: F401 [*] `astropy.units` imported but unused
tardis/io/model/readers/tests/test_csvy_reader.py:48:10: B017 `pytest.raises(Exception)` should be considered evil
tardis/io/model/readers/tests/test_stella_reader.py:1:1: INP001 File `tardis/io/model/readers/tests/test_stella_reader.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/io/model/readers/tests/test_stella_reader.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/model/readers/tests/test_stella_reader.py:5:1: PT013 Incorrect import of `pytest`; use `import pytest` instead
tardis/io/tests/test_HDFWriter.py:1:1: N999 Invalid module name: 'test_HDFWriter'
tardis/io/tests/test_HDFWriter.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/tests/test_HDFWriter.py:6:27: F401 [*] `numpy.testing.assert_almost_equal` imported but unused
tardis/io/tests/test_atomic.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/tests/test_decay.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/io/tests/test_model_reader.py:1:8: F401 [*] `h5py` imported but unused
tardis/io/util.py:18:20: N812 Lowercase `__path__` imported as non-lowercase `TARDIS_PATH`
tardis/io/util.py:62:24: UP004 [*] Class `MockRegexPattern` inherits from `object`
tardis/io/util.py:163:34: F821 Undefined name `basestring`
tardis/io/util.py:191:22: UP004 [*] Class `HDFWriterMixin` inherits from `object`
tardis/io/util.py:193:25: UP008 Use `super()` instead of `super(__class__, self)`
tardis/io/util.py:239:9: RET506 Unnecessary `else` after `raise` statement
tardis/io/util.py:328:21: G004 Logging statement uses f-string
tardis/io/util.py:385:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/io/util.py:392:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/io/util.py:415:13: G004 Logging statement uses f-string
tardis/model/__init__.py:2:44: W291 Trailing whitespace
tardis/model/__init__.py:4:53: W291 Trailing whitespace
tardis/model/__init__.py:5:46: W291 Trailing whitespace
tardis/model/__init__.py:9:31: F401 `tardis.model.base.SimulationState` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/model/base.py:340:12: PTH117 `os.path.isabs()` should be replaced by `Path.is_absolute()`
tardis/model/base.py:353:27: C403 Unnecessary `list` comprehension (rewrite as a `set` comprehension)
tardis/model/base.py:366:27: C403 Unnecessary `list` comprehension (rewrite as a `set` comprehension)
tardis/model/base.py:377:21: G004 Logging statement uses f-string
tardis/model/geometry/radial1d.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/model/geometry/radial1d.py:196:29: UP004 [*] Class `NumbaRadial1DGeometry` inherits from `object`
tardis/model/geometry/tests/test_radial1d.py:1:1: INP001 File `tardis/model/geometry/tests/test_radial1d.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/model/geometry/tests/test_radial1d.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/model/matter/decay.py:20:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/model/matter/decay.py:28:28: C408 Unnecessary `dict` call (rewrite as a literal)
tardis/model/matter/decay.py:36:30: C405 Unnecessary `list` literal (rewrite as a `set` literal)
tardis/model/matter/decay.py:71:23: C408 Unnecessary `dict` call (rewrite as a literal)
tardis/model/matter/decay.py:101:21: G004 Logging statement uses f-string
tardis/model/matter/decay.py:104:17: G004 Logging statement uses f-string
tardis/model/tests/test_base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/model/tests/test_base.py:1:8: F401 [*] `os` imported but unused
tardis/model/tests/test_base.py:2:21: F401 [*] `pathlib.Path` imported but unused
tardis/model/tests/test_csvy_model.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/model/tests/test_csvy_model.py:1:21: F401 [*] `pathlib.Path` imported but unused
tardis/model/tests/test_csvy_model.py:6:30: F401 [*] `astropy.units` imported but unused
tardis/model/tests/test_csvy_model.py:8:38: F401 [*] `tardis.io.atom_data.base.AtomData` imported but unused
tardis/model/tests/test_density.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/model/tests/test_density.py:1:8: F401 [*] `os` imported but unused
tardis/plasma/properties/helium_nlte.py:51:13: UP034 [*] Avoid extraneous parentheses
tardis/plasma/properties/helium_nlte.py:126:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/plasma/properties/helium_nlte.py:178:21: E722 Do not use bare `except`
tardis/plasma/properties/helium_nlte.py:181:29: G004 Logging statement uses f-string
tardis/plasma/properties/helium_nlte.py:214:23: S605 Starting a process with a shell: seems safe, but may be changed in the future; consider rewriting without `shell`
tardis/plasma/properties/helium_nlte.py:231:18: UP015 [*] Unnecessary open mode parameters
tardis/plasma/properties/helium_nlte.py:234:36: PIE808 [*] Unnecessary `start` argument in `range`
tardis/plasma/properties/helium_nlte.py:257:69: F821 Undefined name `s1`
tardis/plasma/properties/ion_population.py:206:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/plasma/properties/ion_population.py:291:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/plasma/properties/ion_population.py:370:25: G004 Logging statement uses f-string
tardis/plasma/properties/ion_population.py:424:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/plasma/properties/ion_population.py:491:25: G004 Logging statement uses f-string
tardis/plasma/properties/level_population.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/plasma/properties/level_population.py:28:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/plasma/properties/partition_function.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/plasma/properties/partition_function.py:145:9: RET505 Unnecessary `elif` after `return` statement
tardis/plasma/properties/partition_function.py:161:14: UP008 Use `super()` instead of `super(__class__, self)`
tardis/plasma/properties/partition_function.py:181:25: G004 Logging statement uses f-string
tardis/plasma/properties/partition_function.py:192:21: G004 Logging statement uses f-string
tardis/plasma/properties/partition_function.py:199:21: G004 Logging statement uses f-string
tardis/plasma/properties/partition_function.py:252:21: RET506 Unnecessary `else` after `raise` statement
tardis/plasma/properties/partition_function.py:395:21: UP008 Use `super()` instead of `super(__class__, self)`
tardis/radiation_field/base.py:1:1: INP001 File `tardis/radiation_field/base.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/radiation_field/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/spectrum/tests/test_spectrum.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/frame_transformations.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/frame_transformations.py:19:5: RET505 Unnecessary `else` after `return` statement
tardis/transport/frame_transformations.py:49:5: RET505 Unnecessary `else` after `return` statement
tardis/transport/geometry/calculate_distances.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/geometry/calculate_distances.py:18:5: F401 [*] `tardis.transport.montecarlo.r_packet.print_r_packet_properties` imported but unused
tardis/transport/geometry/calculate_distances.py:24:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/transport/geometry/calculate_distances.py:73:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/transport/montecarlo/__init__.py:2:39: W291 Trailing whitespace
tardis/transport/montecarlo/__init__.py:6:69: W291 Trailing whitespace
tardis/transport/montecarlo/__init__.py:14:1: E402 Module level import not at top of file
tardis/transport/montecarlo/__init__.py:24:1: E402 Module level import not at top of file
tardis/transport/montecarlo/__init__.py:24:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/__init__.py:24:50: F401 `tardis.transport.montecarlo.r_packet.RPacket` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/transport/montecarlo/__init__.py:25:1: E402 Module level import not at top of file
tardis/transport/montecarlo/__init__.py:26:5: F401 `tardis.transport.montecarlo.packet_collections.PacketCollection` imported but unused; consider removing, adding to `__all__`, or using a redundant alias
tardis/transport/montecarlo/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/configuration/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/configuration/base.py:7:41: F401 [*] `tardis.transport.montecarlo.montecarlo_main_loop` imported but unused
tardis/transport/montecarlo/configuration/base.py:32:31: UP004 [*] Class `MonteCarloConfiguration` inherits from `object`
tardis/transport/montecarlo/estimators/radfield_estimator_calcs.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/interaction.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/macro_atom.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/macro_atom.py:5:41: F401 [*] `tardis.transport.montecarlo.njit_dict` imported but unused
tardis/transport/montecarlo/nonhomologous_grid.py:20:5: D409 [*] Section underline should match the length of its name ("Returns")
tardis/transport/montecarlo/nonhomologous_grid.py:36:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/transport/montecarlo/nonhomologous_grid.py:40:5: D411 [*] Missing blank line before section ("Parameters")
tardis/transport/montecarlo/nonhomologous_grid.py:46:5: D409 [*] Section underline should match the length of its name ("Returns")
tardis/transport/montecarlo/nonhomologous_grid.py:64:5: D409 [*] Section underline should match the length of its name ("Parameters")
tardis/transport/montecarlo/nonhomologous_grid.py:67:5: D411 [*] Missing blank line before section ("Returns")
tardis/transport/montecarlo/nonhomologous_grid.py:68:5: D409 [*] Section underline should match the length of its name ("Returns")
tardis/transport/montecarlo/numba_interface.py:40:20: UP004 [*] Class `OpacityState` inherits from `object`
tardis/transport/montecarlo/numba_interface.py:66:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/transport/montecarlo/numba_interface.py:115:9: ANN204 Missing return type annotation for special method `__getitem__`
tardis/transport/montecarlo/numba_interface.py:121:9: D407 [*] Missing dashed underline after section ("Returns")
tardis/transport/montecarlo/numba_interface.py:121:9: D406 [*] Section name should end with a newline ("Returns")
tardis/transport/montecarlo/numba_interface.py:156:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/transport/montecarlo/packet_source.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/packet_source.py:228:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/transport/montecarlo/packet_source.py:246:9: RET505 Unnecessary `else` after `return` statement
tardis/transport/montecarlo/packet_source.py:270:9: D412 [*] No blank lines allowed between a section header and its content ("Parameters")
tardis/transport/montecarlo/packet_trackers.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/packet_trackers.py:36:22: UP004 [*] Class `RPacketTracker` inherits from `object`
tardis/transport/montecarlo/packet_trackers.py:39:5: D411 [*] Missing blank line before section ("Parameters")
tardis/transport/montecarlo/packet_trackers.py:203:48: B009 [*] Do not call `getattr` with a constant attribute value. It is not any safer than normal property access.
tardis/transport/montecarlo/packet_trackers.py:223:37: UP004 [*] Class `RPacketLastInteractionTracker` inherits from `object`
tardis/transport/montecarlo/packet_trackers.py:226:5: D411 [*] Missing blank line before section ("Parameters")
tardis/transport/montecarlo/packet_trackers.py:268:9: PIE790 [*] Unnecessary `pass` statement
tardis/transport/montecarlo/packet_trackers.py:275:9: PIE790 [*] Unnecessary `pass` statement
tardis/transport/montecarlo/r_packet.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/r_packet.py:4:18: F401 [*] `pandas` imported but unused
tardis/transport/montecarlo/r_packet.py:14:41: F811 [*] Redefinition of unused `njit_dict_no_parallel` from line 9
tardis/transport/montecarlo/r_packet.py:51:15: UP004 [*] Class `RPacket` inherits from `object`
tardis/transport/montecarlo/single_packet_loop.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_base.py:1:8: F401 [*] `os` imported but unused
tardis/transport/montecarlo/tests/test_base.py:3:17: F401 [*] `numpy` imported but unused
tardis/transport/montecarlo/tests/test_base.py:5:30: F401 [*] `astropy.units` imported but unused
tardis/transport/montecarlo/tests/test_base.py:7:21: F401 [*] `pathlib.Path` imported but unused
tardis/transport/montecarlo/tests/test_interaction.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_macro_atom.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_macro_atom.py:3:17: F401 [*] `numpy` imported but unused
tardis/transport/montecarlo/tests/test_montecarlo.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_montecarlo.py:27:1: E402 Module level import not at top of file
tardis/transport/montecarlo/tests/test_montecarlo.py:32:1: E402 Module level import not at top of file
tardis/transport/montecarlo/tests/test_montecarlo.py:48:5: PT021 Use `yield` instead of `request.addfinalizer`
tardis/transport/montecarlo/tests/test_montecarlo.py:204:5: F811 Redefinition of unused `test_get_random_mu_different_output` from line 195
tardis/transport/montecarlo/tests/test_montecarlo.py:484:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:570:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:571:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:579:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:592:9: PT014 Duplicate of test case at index 1 in `@pytest_mark.parametrize`
tardis/transport/montecarlo/tests/test_montecarlo.py:597:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:602:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:625:9: F821 Undefined name `transport`
tardis/transport/montecarlo/tests/test_montecarlo.py:626:9: F821 Undefined name `transport`
tardis/transport/montecarlo/tests/test_montecarlo.py:627:9: F821 Undefined name `transport`
tardis/transport/montecarlo/tests/test_montecarlo.py:628:9: F821 Undefined name `transport`
tardis/transport/montecarlo/tests/test_montecarlo.py:630:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:643:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:667:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo.py:680:5: F821 Undefined name `mc`
tardis/transport/montecarlo/tests/test_montecarlo_main_loop.py:11:5: PT015 Assertion always fails, replace with `pytest.fail()`
tardis/transport/montecarlo/tests/test_montecarlo_main_loop.py:11:12: B011 Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`
tardis/transport/montecarlo/tests/test_numba_interface.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_numba_interface.py:80:5: PT015 Assertion always fails, replace with `pytest.fail()`
tardis/transport/montecarlo/tests/test_numba_interface.py:80:12: B011 Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`
tardis/transport/montecarlo/tests/test_opacities.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_packet.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_packet.py:8:38: F811 [*] Redefinition of unused `opacities` from line 4
tardis/transport/montecarlo/tests/test_packet.py:9:50: F811 [*] Redefinition of unused `frame_transformations` from line 5
tardis/transport/montecarlo/tests/test_packet.py:10:57: F811 [*] Redefinition of unused `calculate_distances` from line 6
tardis/transport/montecarlo/tests/test_packet.py:12:55: F401 [*] `tardis.transport.montecarlo.numba_interface` imported but unused
tardis/transport/montecarlo/tests/test_packet.py:15:50: F811 [*] Redefinition of unused `frame_transformations` from line 9
tardis/transport/montecarlo/tests/test_packet.py:16:57: F811 [*] Redefinition of unused `calculate_distances` from line 10
tardis/transport/montecarlo/tests/test_packet.py:27:1: E402 Module level import not at top of file
tardis/transport/montecarlo/tests/test_packet_source.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_packet_source.py:1:8: F401 [*] `os` imported but unused
tardis/transport/montecarlo/tests/test_packet_source.py:5:18: F401 [*] `pandas` imported but unused
tardis/transport/montecarlo/tests/test_packet_source.py:13:51: F401 [*] `tardis.tests.fixtures.regression_data.RegressionData` imported but unused
tardis/transport/montecarlo/tests/test_rpacket_last_interaction_tracker.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_rpacket_tracker.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_single_packet_loop.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_single_packet_loop.py:52:5: PT015 Assertion always fails, replace with `pytest.fail()`
tardis/transport/montecarlo/tests/test_single_packet_loop.py:52:12: B011 Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`
tardis/transport/montecarlo/tests/test_single_packet_loop.py:57:5: PT015 Assertion always fails, replace with `pytest.fail()`
tardis/transport/montecarlo/tests/test_single_packet_loop.py:57:12: B011 Do not `assert False` (`python -O` removes these calls), raise `AssertionError()`
tardis/transport/montecarlo/tests/test_tracker_utils.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_tracker_utils.py:1:8: F401 [*] `pytest` imported but unused
tardis/transport/montecarlo/tests/test_vpacket.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_vpacket.py:1:8: F401 [*] `os` imported but unused
tardis/transport/montecarlo/tests/test_vpacket.py:4:18: F401 [*] `pandas` imported but unused
tardis/transport/montecarlo/tests/test_vpacket.py:14:1: E402 Module level import not at top of file
tardis/transport/montecarlo/tests/test_weighted_packet_source.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/tests/test_weighted_packet_source.py:1:8: F401 [*] `os` imported but unused
tardis/transport/montecarlo/tests/test_weighted_packet_source.py:4:17: F401 [*] `numpy` imported but unused
tardis/transport/montecarlo/tests/test_weighted_packet_source.py:5:18: F401 [*] `pandas` imported but unused
tardis/transport/montecarlo/tests/test_weighted_packet_source.py:12:51: F401 [*] `tardis.tests.fixtures.regression_data.RegressionData` imported but unused
tardis/transport/montecarlo/utils.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/weighted_packet_source.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/montecarlo/weighted_packet_source.py:1:19: F401 [*] `numexpr` imported but unused
tardis/transport/montecarlo/weighted_packet_source.py:2:17: F401 [*] `numpy` imported but unused
tardis/transport/montecarlo/weighted_packet_source.py:3:34: F401 [*] `astropy.constants` imported but unused
tardis/transport/montecarlo/weighted_packet_source.py:7:5: F401 [*] `tardis.transport.montecarlo.packet_source.BasePacketSource` imported but unused
tardis/transport/montecarlo/weighted_packet_source.py:8:5: F401 [*] `tardis.transport.montecarlo.packet_source.HDFWriterMixin` imported but unused
tardis/transport/montecarlo/weighted_packet_source.py:84:13: B018 Found useless expression. Either assign it to a variable or remove it.
tardis/transport/tests/test_doppler_factor.py:1:1: INP001 File `tardis/transport/tests/test_doppler_factor.py` is part of an implicit namespace package. Add an `__init__.py`.
tardis/transport/tests/test_doppler_factor.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/transport/tests/test_doppler_factor.py:2:17: F401 [*] `numpy` imported but unused
tardis/transport/tests/test_doppler_factor.py:5:48: F401 [*] `tardis.transport.montecarlo.r_packet` imported but unused
tardis/util/base.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/util/base.py:12:30: F401 [*] `radioactivedecay.Nuclide` imported but unused
tardis/util/base.py:119:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/util/base.py:135:12: C414 Unnecessary `list` call within `set()`
tardis/util/base.py:196:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/util/base.py:234:13: PIE790 [*] Unnecessary `pass` statement
tardis/util/base.py:344:5: RET505 Unnecessary `else` after `return` statement
tardis/util/base.py:349:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/util/base.py:405:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/util/base.py:483:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/util/base.py:502:5: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/util/base.py:522:5: E722 Do not use bare `except`
tardis/util/base.py:523:22: SIM210 Remove unnecessary `True if ... else False`
tardis/util/base.py:630:5: RET505 Unnecessary `elif` after `return` statement
tardis/util/base.py:776:5: D412 [*] No blank lines allowed between a section header and its content ("Parameters")
tardis/visualization/tools/convergence_plot.py:3:1: I001 [*] Import block is un-sorted or un-formatted
tardis/visualization/tools/convergence_plot.py:4:25: F401 [*] `matplotlib.cm` imported but unused
tardis/visualization/tools/convergence_plot.py:5:29: F401 [*] `matplotlib.colors` imported but unused
tardis/visualization/tools/convergence_plot.py:39:24: UP004 [*] Class `ConvergencePlots` inherits from `object`
tardis/visualization/tools/convergence_plot.py:321:13: ISC003 Explicitly concatenated string should be implicitly concatenated
tardis/visualization/tools/liv_plot.py:1:1: I001 [*] Import block is un-sorted or un-formatted
tardis/visualization/tools/liv_plot.py:25:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/visualization/tools/liv_plot.py:48:9: D202 [*] No blank lines allowed after function docstring (found 1)
tardis/visualization/tools/liv_plot.py:341:13: RET506 Unnecessary `elif` after `raise` statement
tardis/visualization/tools/sdec_plot.py:202:9: RET505 Unnecessary `elif` after `return` statement
tardis/visualization/tools/sdec_plot.py:343:13: RET505 Unnecessary `elif` after `return` statement
tardis/visualization/tools/sdec_plot.py:460:9: RET505 Unnecessary `else` after `return` statement
tardis/visualization/tools/sdec_plot.py:496:9: RET505 Unnecessary `elif` after `return` statement
tardis/visualization/tools/sdec_plot.py:531:13: RET506 Unnecessary `else` after `raise` statement
tardis/visualization/tools/sdec_plot.py:699:13: RET506 Unnecessary `else` after `raise` statement
tardis/visualization/widgets/util.py:3:1: I001 [*] Import block is un-sorted or un-formatted
Found 508 errors.
[*] 307 fixable with the `--fix` option (60 hidden fixes can be enabled with the `--unsafe-fixes` option).

@tardis-bot
Copy link
Contributor

tardis-bot commented Sep 20, 2024

*beep* *bop*
Hi human,
I ran benchmarks as you asked comparing master (62395d3) and the latest commit (3251615).
Here are the logs produced by ASV.
Results can also be downloaded as artifacts here.

Significantly changed benchmarks:

All benchmarks:

Benchmarks that have stayed the same:

| Change   | Before [1c3befd0] <master>   | After [32516156]    | Ratio   | Benchmark (Parameter)                                                                                                               |
|----------|------------------------------|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------|
|          | 20.5±5μs                     | 31.9±10μs           | ~1.56   | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_last_interaction_tracker_list |
|          | 45.0±30μs                    | 62.5±30μs           | ~1.39   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_scatter                                          |
|          | 3.57±0ms                     | 4.58±0.04ms         | ~1.28   | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('macroatom')                                   |
|          | 42.3±20μs                    | 52.6±30μs           | ~1.24   | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_line_emission                                         |
|          | 2.62±0.01ms                  | 3.24±0.01ms         | ~1.23   | opacities_opacity_state.BenchmarkOpacitiesOpacityState.time_opacity_state_initialize('scatter')                                     |
|          | 2.92±0.5μs                   | 3.47±0.3μs          | ~1.19   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_bad_vpacket                                       |
|          | 5.98±0.7μs                   | 6.93±1μs            | ~1.16   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket                                           |
|          | 1.38±0.3μs                   | 1.57±0.5μs          | ~1.14   | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_line                    |
|          | 571±200ns                    | 642±100ns           | ~1.12   | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_pair_creation_opacity_calculation                                |
|          | 8.04±2μs                     | 9.04±2μs            | ~1.12   | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_volley                                    |
|          | 3.19±0.4μs                   | 3.43±0.6μs          | 1.08    | transport_montecarlo_vpacket.BenchmarkMontecarloMontecarloNumbaVpacket.time_trace_vpacket_within_shell                              |
|          | 1.66±0.01ms                  | 1.78±0.01ms         | 1.07    | transport_montecarlo_main_loop.BenchmarkTransportMontecarloMontecarloMainLoop.time_montecarlo_main_loop                             |
|          | 63.7±0.2ms                   | 67.5±0.3ms          | 1.06    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_rpacket_trackers_to_dataframe                  |
|          | 2.12±1μs                     | 2.23±4μs            | 1.05    | transport_montecarlo_estimators_radfield_estimator_calcs.BenchmarkMontecarloMontecarloNumbaPacket.time_update_line_estimators       |
|          | 36.9±0.04s                   | 38.2±0.4s           | 1.03    | run_tardis.BenchmarkRunTardis.time_run_tardis                                                                                       |
|          | 2.68±0.4ms                   | 2.77±0.4ms          | 1.03    | transport_montecarlo_single_packet_loop.BenchmarkTransportMontecarloSinglePacketLoop.time_single_packet_loop                        |
|          | 601±200ns                    | 611±200ns           | 1.02    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_photoabsorption_opacity_calculation                              |
|          | 1.03±0.01m                   | 1.04±0m             | 1.01    | run_tardis.BenchmarkRunTardis.time_run_tardis_rpacket_tracking                                                                      |
|          | 1.22±0μs                     | 1.23±0μs            | 1.01    | transport_geometry_calculate_distances.BenchmarkTransportGeometryCalculateDistances.time_calculate_distance_boundary                |
|          | 757±1ns                      | 764±3ns             | 1.01    | transport_montecarlo_interaction.BenchmarkTransportMontecarloInteraction.time_thomson_scatter                                       |
|          | 501±200ns                    | 501±200ns           | 1.00    | opacities_opacity.BenchmarkMontecarloMontecarloNumbaOpacities.time_compton_opacity_calculation                                      |
|          | 2.08±0m                      | 2.09±0m             | 1.00    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_FormalIntegrator_functions                                 |
|          | 210±0.1ns                    | 205±0.1ns           | 0.97    | spectrum_formal_integral.BenchmarkTransportMontecarloFormalIntegral.time_intensity_black_body                                       |
|          | 31.5±0μs                     | 30.5±0.04μs         | 0.97    | transport_montecarlo_packet_trackers.BenchmarkTransportMontecarloPacketTrackers.time_generate_rpacket_tracker_list                  |

If you want to see the graph of the results, you can check it here

@DeerWhale DeerWhale marked this pull request as draft September 23, 2024 14:20
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tardis-bot
Copy link
Contributor

*beep* *bop*

Hi, human.

I'm the @tardis-bot and couldn't find your records in my database. I think we don't know each other, or you changed your credentials recently.

Please add your name and email to .mailmap in your current branch and push the changes to this pull request.

In case you need to map an existing alias, follow this example.

Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.51%. Comparing base (62395d3) to head (3251615).
Report is 20 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2824      +/-   ##
==========================================
- Coverage   70.99%   70.51%   -0.49%     
==========================================
  Files         209      209              
  Lines       15650    15589      -61     
==========================================
- Hits        11111    10992     -119     
- Misses       4539     4597      +58     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jvshields jvshields marked this pull request as ready for review October 8, 2024 15:27
@andrewfullard andrewfullard merged commit b3af245 into tardis-sn:master Oct 8, 2024
20 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants