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

Documentation / poetry improvements and fixes #773

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

sjoerd-bouma
Copy link
Collaborator

I suppose technically this could have been two PRs but no functionality should be affected.

  1. Optional dependencies weren't really implemented correctly in pyproject.toml (I accept full responsibility). This made very little difference, but the advantage is they can now be installed also using the conventional pip syntax pip install nuradiomc[documentation, proposal] to install the correct optional dependencies. Previously, optional dependencies were implemented as developer dependencies, and would never be installed during pip installation.
  2. The rest is minor fixes to the documentation: some missing docstrings from the recent refactoring, and an attempt to somewhat tidy up the new 'overview of times' page, though I find the content somewhat unclear still. The table of contents on code documentation pages now also only shows top-level submodule and subpackage names instead of every method of every class inside them, which I think improves clarity,


* efieldToVoltageConverter: the traces are rolled (rotated) according to the time delay due to the geometric separation of the antennas and cable delays.
* `NuRadioReco.modules.efieldToVoltageConverter`: the traces are rolled (rotated) according to the time delay due to the geometric separation of the antennas and cable delays.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isnt this wrong? This module only changes the trace start time but does no rolling.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants