From 26d961a5a111b4148ce41e7d05b452c630dc5033 Mon Sep 17 00:00:00 2001 From: Nathan Keim Date: Sun, 18 Feb 2024 07:09:39 -0500 Subject: [PATCH] Development docs for trackpy v0.6.2 --- trackpy/dev/.buildinfo | 2 +- trackpy/dev/_sources/installation.rst.txt | 19 +++++++++------ trackpy/dev/_static/documentation_options.js | 2 +- trackpy/dev/api.html | 4 +-- trackpy/dev/examples/index.html | 4 +-- .../trackpy.FramewiseData.close.html | 4 +-- .../generated/trackpy.FramewiseData.dump.html | 4 +-- .../trackpy.FramewiseData.frames.html | 4 +-- .../generated/trackpy.FramewiseData.get.html | 4 +-- .../dev/generated/trackpy.FramewiseData.html | 4 +-- .../trackpy.FramewiseData.max_frame.html | 4 +-- .../generated/trackpy.FramewiseData.put.html | 4 +-- .../trackpy.FramewiseData.t_column.html | 4 +-- .../trackpy.PandasHDFStore.close.html | 4 +-- .../trackpy.PandasHDFStore.dump.html | 4 +-- .../trackpy.PandasHDFStore.frames.html | 4 +-- .../generated/trackpy.PandasHDFStore.get.html | 4 +-- .../dev/generated/trackpy.PandasHDFStore.html | 4 +-- .../trackpy.PandasHDFStore.max_frame.html | 4 +-- .../generated/trackpy.PandasHDFStore.put.html | 4 +-- .../trackpy.PandasHDFStore.t_column.html | 4 +-- .../trackpy.PandasHDFStoreBig.close.html | 4 +-- .../trackpy.PandasHDFStoreBig.dump.html | 4 +-- .../trackpy.PandasHDFStoreBig.frames.html | 4 +-- .../trackpy.PandasHDFStoreBig.get.html | 4 +-- .../generated/trackpy.PandasHDFStoreBig.html | 4 +-- .../trackpy.PandasHDFStoreBig.max_frame.html | 4 +-- .../trackpy.PandasHDFStoreBig.put.html | 4 +-- ...ackpy.PandasHDFStoreBig.rebuild_cache.html | 4 +-- .../trackpy.PandasHDFStoreBig.t_column.html | 4 +-- ...rackpy.PandasHDFStoreSingleNode.close.html | 4 +-- ...trackpy.PandasHDFStoreSingleNode.dump.html | 4 +-- ...ackpy.PandasHDFStoreSingleNode.frames.html | 4 +-- .../trackpy.PandasHDFStoreSingleNode.get.html | 4 +-- .../trackpy.PandasHDFStoreSingleNode.html | 4 +-- ...py.PandasHDFStoreSingleNode.max_frame.html | 4 +-- .../trackpy.PandasHDFStoreSingleNode.put.html | 4 +-- ...kpy.PandasHDFStoreSingleNode.t_column.html | 4 +-- .../trackpy.SubnetOversizeException.html | 4 +-- trackpy/dev/generated/trackpy.annotate.html | 4 +-- trackpy/dev/generated/trackpy.annotate3d.html | 4 +-- trackpy/dev/generated/trackpy.api.html | 4 +-- trackpy/dev/generated/trackpy.artificial.html | 4 +-- trackpy/dev/generated/trackpy.batch.html | 4 +-- .../generated/trackpy.diag.dependencies.html | 4 +-- trackpy/dev/generated/trackpy.diag.html | 4 +-- .../trackpy.diag.performance_report.html | 4 +-- .../dev/generated/trackpy.disable_numba.html | 4 +-- .../dev/generated/trackpy.enable_numba.html | 4 +-- trackpy/dev/generated/trackpy.feature.html | 4 +-- .../trackpy.filtering.filter_clusters.html | 4 +-- .../trackpy.filtering.filter_stubs.html | 4 +-- trackpy/dev/generated/trackpy.filtering.html | 4 +-- trackpy/dev/generated/trackpy.find.html | 4 +-- .../trackpy.find.percentile_threshold.html | 4 +-- trackpy/dev/generated/trackpy.find_link.html | 4 +-- .../dev/generated/trackpy.framewise_data.html | 4 +-- .../dev/generated/trackpy.grey_dilation.html | 4 +-- .../dev/generated/trackpy.handle_logging.html | 4 +-- trackpy/dev/generated/trackpy.html | 4 +-- .../dev/generated/trackpy.ignore_logging.html | 4 +-- trackpy/dev/generated/trackpy.link.html | 4 +-- .../dev/generated/trackpy.link_df_iter.html | 4 +-- trackpy/dev/generated/trackpy.link_iter.html | 4 +-- .../dev/generated/trackpy.link_partial.html | 4 +-- .../generated/trackpy.linking.find_link.html | 4 +-- trackpy/dev/generated/trackpy.linking.html | 4 +-- .../dev/generated/trackpy.linking.legacy.html | 4 +-- .../generated/trackpy.linking.linking.html | 4 +-- .../generated/trackpy.linking.partial.html | 4 +-- .../dev/generated/trackpy.linking.subnet.html | 4 +-- .../trackpy.linking.subnetlinker.html | 4 +-- .../dev/generated/trackpy.linking.utils.html | 4 +-- trackpy/dev/generated/trackpy.locate.html | 4 +-- ...kpy.locate_functions.brightfield_ring.html | 4 +-- .../generated/trackpy.locate_functions.html | 4 +-- .../generated/trackpy.masks.binary_mask.html | 4 +-- .../dev/generated/trackpy.masks.cosmask.html | 4 +-- .../trackpy.masks.gaussian_kernel.html | 4 +-- trackpy/dev/generated/trackpy.masks.html | 4 +-- .../generated/trackpy.masks.mask_image.html | 4 +-- .../trackpy.masks.r_squared_mask.html | 4 +-- .../dev/generated/trackpy.masks.sinmask.html | 4 +-- .../generated/trackpy.masks.slice_image.html | 4 +-- .../generated/trackpy.masks.theta_mask.html | 4 +-- .../trackpy.masks.x_squared_masks.html | 4 +-- trackpy/dev/generated/trackpy.mass_ecc.html | 4 +-- trackpy/dev/generated/trackpy.mass_size.html | 4 +-- .../generated/trackpy.minmass_v03_change.html | 4 +-- .../generated/trackpy.minmass_v04_change.html | 4 +-- .../trackpy.motion.compute_drift.html | 4 +-- .../trackpy.motion.diagonal_size.html | 4 +-- .../trackpy.motion.direction_corr.html | 4 +-- .../dev/generated/trackpy.motion.emsd.html | 4 +-- trackpy/dev/generated/trackpy.motion.html | 4 +-- .../dev/generated/trackpy.motion.imsd.html | 4 +-- .../generated/trackpy.motion.is_typical.html | 4 +-- ...ckpy.motion.min_rolling_theta_entropy.html | 4 +-- trackpy/dev/generated/trackpy.motion.msd.html | 4 +-- .../trackpy.motion.relate_frames.html | 4 +-- .../trackpy.motion.subtract_drift.html | 4 +-- .../trackpy.motion.theta_entropy.html | 4 +-- .../dev/generated/trackpy.motion.vanhove.html | 4 +-- .../trackpy.motion.velocity_corr.html | 4 +-- .../trackpy.plot_density_profile.html | 4 +-- .../generated/trackpy.plot_displacements.html | 4 +-- trackpy/dev/generated/trackpy.plot_traj.html | 4 +-- .../dev/generated/trackpy.plot_traj3d.html | 4 +-- trackpy/dev/generated/trackpy.plots.html | 4 +-- .../trackpy.predict.ChannelPredict.html | 4 +-- ...rackpy.predict.ChannelPredict.link_df.html | 4 +-- ...y.predict.ChannelPredict.link_df_iter.html | 4 +-- ...rackpy.predict.ChannelPredict.observe.html | 4 +-- ...rackpy.predict.ChannelPredict.predict.html | 4 +-- .../trackpy.predict.ChannelPredict.state.html | 4 +-- .../trackpy.predict.ChannelPredict.wrap.html | 4 +-- ...py.predict.ChannelPredict.wrap_single.html | 4 +-- .../trackpy.predict.DriftPredict.html | 4 +-- .../trackpy.predict.DriftPredict.link_df.html | 4 +-- ...kpy.predict.DriftPredict.link_df_iter.html | 4 +-- .../trackpy.predict.DriftPredict.observe.html | 4 +-- .../trackpy.predict.DriftPredict.predict.html | 4 +-- .../trackpy.predict.DriftPredict.state.html | 4 +-- .../trackpy.predict.DriftPredict.wrap.html | 4 +-- ...ckpy.predict.DriftPredict.wrap_single.html | 4 +-- ...rackpy.predict.NearestVelocityPredict.html | 4 +-- ...redict.NearestVelocityPredict.link_df.html | 4 +-- ...t.NearestVelocityPredict.link_df_iter.html | 4 +-- ...redict.NearestVelocityPredict.observe.html | 4 +-- ...redict.NearestVelocityPredict.predict.html | 4 +-- ....predict.NearestVelocityPredict.state.html | 4 +-- ...y.predict.NearestVelocityPredict.wrap.html | 4 +-- ...ct.NearestVelocityPredict.wrap_single.html | 4 +-- .../trackpy.predict.NullPredict.html | 4 +-- .../trackpy.predict.NullPredict.link_df.html | 4 +-- ...ckpy.predict.NullPredict.link_df_iter.html | 4 +-- .../trackpy.predict.NullPredict.observe.html | 4 +-- .../trackpy.predict.NullPredict.predict.html | 4 +-- .../trackpy.predict.NullPredict.state.html | 4 +-- .../trackpy.predict.NullPredict.wrap.html | 4 +-- ...ackpy.predict.NullPredict.wrap_single.html | 4 +-- trackpy/dev/generated/trackpy.predict.html | 4 +-- .../trackpy.predict.instrumented.html | 4 +-- .../generated/trackpy.predict.predictor.html | 4 +-- .../trackpy.preprocessing.bandpass.html | 4 +-- .../trackpy.preprocessing.convert_to_int.html | 4 +-- .../dev/generated/trackpy.preprocessing.html | 4 +-- .../trackpy.preprocessing.invert_image.html | 4 +-- .../trackpy.preprocessing.lowpass.html | 4 +-- .../trackpy.preprocessing.scale_to_gamut.html | 4 +-- trackpy/dev/generated/trackpy.quiet.html | 4 +-- .../trackpy.reconnect_traj_patch.html | 4 +-- .../trackpy.refine.brightfield_ring.html | 4 +-- .../trackpy.refine.center_of_mass.html | 4 +-- trackpy/dev/generated/trackpy.refine.html | 4 +-- .../trackpy.refine.least_squares.html | 4 +-- trackpy/dev/generated/trackpy.refine_com.html | 4 +-- .../dev/generated/trackpy.refine_leastsq.html | 4 +-- trackpy/dev/generated/trackpy.scatter.html | 4 +-- trackpy/dev/generated/trackpy.scatter3d.html | 4 +-- .../dev/generated/trackpy.static.cluster.html | 4 +-- trackpy/dev/generated/trackpy.static.html | 4 +-- .../trackpy.static.pair_correlation_2d.html | 4 +-- .../trackpy.static.pair_correlation_3d.html | 4 +-- .../generated/trackpy.static.proximity.html | 4 +-- trackpy/dev/generated/trackpy.subpx_bias.html | 4 +-- trackpy/dev/generated/trackpy.tracking.html | 4 +-- trackpy/dev/generated/trackpy.try_numba.html | 4 +-- .../dev/generated/trackpy.uncertainty.html | 4 +-- .../generated/trackpy.utils.fit_powerlaw.html | 4 +-- trackpy/dev/generated/trackpy.utils.html | 4 +-- trackpy/dev/genindex.html | 4 +-- trackpy/dev/index.html | 4 +-- trackpy/dev/installation.html | 23 ++++++++++-------- trackpy/dev/introduction.html | 4 +-- trackpy/dev/objects.inv | Bin 4262 -> 4273 bytes trackpy/dev/search.html | 4 +-- trackpy/dev/searchindex.js | 2 +- trackpy/dev/tutorial.html | 4 +-- trackpy/dev/tutorial/adaptive-search.html | 4 +-- trackpy/dev/tutorial/brightfield.html | 4 +-- .../tutorial/custom-feature-detection.html | 4 +-- trackpy/dev/tutorial/on-disk.html | 4 +-- trackpy/dev/tutorial/parallel-locate.html | 4 +-- trackpy/dev/tutorial/performance.html | 4 +-- trackpy/dev/tutorial/prediction.html | 4 +-- trackpy/dev/tutorial/subnets.html | 4 +-- trackpy/dev/tutorial/tracking-3d.html | 4 +-- trackpy/dev/tutorial/uncertainty.html | 4 +-- trackpy/dev/tutorial/walkthrough.html | 4 +-- trackpy/dev/whatsnew.html | 4 +-- 191 files changed, 397 insertions(+), 391 deletions(-) diff --git a/trackpy/dev/.buildinfo b/trackpy/dev/.buildinfo index f5f0992b..b5a782c0 100644 --- a/trackpy/dev/.buildinfo +++ b/trackpy/dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: d3c254abaeee09d9396b83fc148bdcec +config: a381ef82ffa281ccad741d37d40d9c4c tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/trackpy/dev/_sources/installation.rst.txt b/trackpy/dev/_sources/installation.rst.txt index 0316425f..c8390cdb 100644 --- a/trackpy/dev/_sources/installation.rst.txt +++ b/trackpy/dev/_sources/installation.rst.txt @@ -66,13 +66,14 @@ run this in the command prompt: Latest Version Under Development ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The `master` branch on github contains the latest tested development code. -Changes are thoroughly tested before being merged. If you want to use the -latest features it should be safe to rely on the master branch. -(The primary contributors do.) +The ``master`` branch on GitHub contains the latest tested development code. +Sometimes this branch will be compatible with the very latest versions of +other packages (especially pandas or scipy) weeks or months before a new +stable version is released. Code in this branch has already been thoroughly +tested. You can easily install a recent build by downloading the source from -`Github `_: +`GitHub `_: .. code-block:: bash @@ -90,7 +91,7 @@ environment with the name softmatter as follows: .. code-block:: bash - conda create --name softmatter python=3.7 trackpy nb_conda + conda create --name softmatter trackpy nb_conda The `nb_conda` is optional, but we added it to ensure that Jupyter sees this environment as well. You can switch to the environment from within Jupyter in @@ -117,11 +118,13 @@ pip """ We strongly recommend using conda to install trackpy, as described above, -but pip is also supported. +but pip is also supported. In general, you can use the latest version of each dependency. +If you wish to override trackpy's minimum version requirements, you may find that +trackpy still runs your analysis code with older versions of dependencies. Essential Dependencies: -* Python 3.7 or newer. (trackpy on Python 2.7 and older Python 3.x is no longer officially supported, though it is still likely to run.) +* Python 3 * `setuptools `__ * `numpy `__ * `scipy `__ diff --git a/trackpy/dev/_static/documentation_options.js b/trackpy/dev/_static/documentation_options.js index 038e6439..ca7c30eb 100644 --- a/trackpy/dev/_static/documentation_options.js +++ b/trackpy/dev/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.6.2rc1', + VERSION: '0.6.2rc1+1.gc976867', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/trackpy/dev/api.html b/trackpy/dev/api.html index 39880c24..96cf5687 100644 --- a/trackpy/dev/api.html +++ b/trackpy/dev/api.html @@ -5,7 +5,7 @@ - API reference — trackpy 0.6.2rc1 documentation + API reference — trackpy 0.6.2rc1+1.gc976867 documentation @@ -39,7 +39,7 @@ trackpy - 0.6.2rc1 + 0.6.2rc1+1.gc976867