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.

Sign up for GitHub

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 docs build #21

Merged
merged 3 commits into from
Jul 8, 2024
Merged

Fix docs build #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a9d40c
fix function name in docs
DomFijan Jul 8, 2024
440c6c0
expose map_ and reduce_ for docs
DomFijan Jul 8, 2024
a7d4922
update text for citing.
DomFijan Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/citing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ Please acknowledge the use of this software within the body of your publication

*Event detection for this publication used the dupin library[1].*

The following is a BibTex citation for the current pre-print.
Before submitting please check to see if this has been updated with the submitted journal paper::
The following is a BibTex citation for the dupin paper::

@article{butler2023change,
title = {Change point detection of events in molecular simulations using dupin},
Expand Down
4 changes: 2 additions & 2 deletions docs/module-preprocessing-signal.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ dupin.preprocessing.signal
.. autosummary::
:nosignatures:

fft_smoothing
high_frequency_smoothing
moving_average

.. rubric:: Details

.. automodule:: dupin.preprocessing.signal
:synopsis: Functions for transforming feature signals across time.
:members: fft_smoothing,
:members: high_frequency_smoothing,
moving_average
4 changes: 4 additions & 0 deletions dupin/data/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ def generator():

from . import aggregate, base, freud, logging, map, reduce, spatial
from .base import make_generator
from .map import map_
from .reduce import reduce_

__all__ = (
"aggregate",
Expand All @@ -72,4 +74,6 @@ def generator():
"reduce",
"spatial",
"make_generator",
"map_",
"reduce_",
)