File size: 31,783 Bytes
ae97a0a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 | <!DOCTYPE html>
<html lang="en" data-bs-theme="light">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="Zipeng Wu">
<link rel="canonical" href="https://systems-mechanobiology.github.io/DeTime/install/">
<link rel="shortcut icon" href="../img/favicon.ico">
<title>Install - DeTime</title>
<link href="../css/bootstrap.min.css" rel="stylesheet">
<link href="../css/fontawesome.min.css" rel="stylesheet">
<link href="../css/brands.min.css" rel="stylesheet">
<link href="../css/solid.min.css" rel="stylesheet">
<link href="../css/v4-font-face.min.css" rel="stylesheet">
<link href="../css/base.css" rel="stylesheet">
<link id="hljs-light" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" >
<link id="hljs-dark" rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github-dark.min.css" disabled>
<link href="../stylesheets/brand.css" rel="stylesheet">
<link href="../stylesheets/extra.css" rel="stylesheet">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<meta name="robots" content="index, follow, max-image-preview:large">
<meta name="keywords" content="DeTime, detime, de-time, time series decomposition, Python time series, SSA, MSSA, VMD, STL, decomposition software">
<meta property="og:site_name" content="DeTime">
<meta property="og:type" content="website">
<meta property="og:title" content="DeTime - workflow-oriented time-series decomposition for Python">
<meta property="og:description" content="DeTime is a Python and CLI toolkit for reproducible time-series decomposition across SSA, MSSA, VMD, STL, EMD, wavelet, and native C++ backed methods.">
<meta property="og:url" content="https://systems-mechanobiology.github.io/DeTime/">
<meta property="og:image" content="https://systems-mechanobiology.github.io/DeTime/assets/brand/detime-title-card.svg">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="DeTime - time-series decomposition for Python">
<meta name="twitter:description" content="Workflow-oriented Python and CLI software for reproducible trend, oscillation, residual, and component decomposition.">
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@graph": [
{
"@type": "WebSite",
"@id": "https://systems-mechanobiology.github.io/DeTime/#website",
"name": "DeTime",
"alternateName": ["detime", "de-time", "De-Time"],
"url": "https://systems-mechanobiology.github.io/DeTime/",
"description": "DeTime documentation for workflow-oriented time-series decomposition software.",
"inLanguage": "en"
},
{
"@type": "SoftwareSourceCode",
"@id": "https://systems-mechanobiology.github.io/DeTime/#software",
"name": "DeTime",
"alternateName": ["detime", "de-time", "De-Time"],
"description": "Python and CLI toolkit for reproducible time-series decomposition with native C++ backed SSA, MSSA, VMD, STD, STDR, MA baseline, and Gabor clustering paths.",
"codeRepository": "https://github.com/systems-mechanobiology/DeTime",
"url": "https://systems-mechanobiology.github.io/DeTime/",
"programmingLanguage": ["Python", "C++"],
"applicationCategory": "Scientific software",
"keywords": "DeTime, time-series decomposition, Python, SSA, MSSA, VMD, STL, EMD, wavelet, native C++",
"author": {
"@type": "Person",
"name": "Zipeng Wu"
}
}
]
}
</script>
<link rel="stylesheet" href="../stylesheets/extra.css?v=7">
</head>
<body>
<div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
<div class="container">
<a class="navbar-brand" href="..">DeTime</a>
<!-- Expander button -->
<button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbar-collapse" aria-controls="navbar-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<!-- Expanded navigation -->
<div id="navbar-collapse" class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="nav-item">
<a href=".." class="nav-link">Home</a>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle active" aria-current="page" role="button" data-bs-toggle="dropdown" aria-expanded="false">Start</a>
<ul class="dropdown-menu">
<li>
<a href="./" class="dropdown-item active" aria-current="page">Install</a>
</li>
<li>
<a href="../quickstart/" class="dropdown-item">Quickstart</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Methods</a>
<ul class="dropdown-menu">
<li>
<a href="../methods/" class="dropdown-item">Methods & Chooser</a>
</li>
<li>
<a href="../method-matrix/" class="dropdown-item">Method Matrix</a>
</li>
<li>
<a href="../method-references/" class="dropdown-item">Method References</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Workflows</a>
<ul class="dropdown-menu">
<li>
<a href="../notebook-gallery/" class="dropdown-item">Notebook Gallery</a>
</li>
<li>
<a href="../tutorials/univariate/" class="dropdown-item">Univariate Tutorial</a>
</li>
<li>
<a href="../tutorials/multivariate/" class="dropdown-item">Multivariate Tutorial</a>
</li>
<li>
<a href="../tutorials/cli-and-profiling/" class="dropdown-item">CLI Guide</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Quant Trading Tutorial</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/" class="dropdown-item">Overview</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/" class="dropdown-item">Tutorial Notebooks</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/00_decomposition_first_quant_trading_roadmap/" class="dropdown-item">Tutorial 00 Roadmap</a>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Strategy Lab</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/two-strategy-families/" class="dropdown-item">Two Strategy Families</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/01_detime_trend_following_strategy_lab/" class="dropdown-item">01 Trend-Following Lab</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/02_detime_oscillation_reversion_strategy_lab/" class="dropdown-item">02 Oscillation-Reversion Lab</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Strategy Expansion</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/method-specific-strategy-expansion/" class="dropdown-item">Method-Specific Strategy Expansion</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/03_detime_method_specific_strategy_variants/" class="dropdown-item">03 Method-Specific Variants</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/04_detime_component_pair_trading_cointegration/" class="dropdown-item">04 Component Pair Trading</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Tutorial Sequence</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/notebooks/01_market_data_and_decomposition_feature_factory/" class="dropdown-item">01 Real Market Data and Feature Factory</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/02_decomposition_aware_moving_average_macd/" class="dropdown-item">02 Decomposition-aware MA and MACD</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/03_residual_mean_reversion_rsi_bollinger/" class="dropdown-item">03 Residual Mean Reversion</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/04_turtle_donchian_breakout_volume_confirmation/" class="dropdown-item">04 Donchian Breakout</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/05_pairs_spread_decomposition_stat_arb/" class="dropdown-item">05 Pair-Spread Stat-Arb</a>
</li>
<li>
<a href="../tutorials/quant-trading/notebooks/06_cross_sectional_rotation_portfolio/" class="dropdown-item">06 Cross-Sectional Rotation</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Native SSA Replay</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/quant-trading/notebooks/07_native_ssa_high_return_low_drawdown_tutorial/" class="dropdown-item">07 Native SSA High-Return / Low-Drawdown</a>
</li>
</ul>
</li>
<li>
<a href="../tutorials/quant-trading/data/" class="dropdown-item">Real Data and Universes</a>
</li>
<li>
<a href="../tutorials/quant-trading/strategy-map/" class="dropdown-item">Strategy Map</a>
</li>
<li>
<a href="../tutorials/quant-trading/backtesting-frameworks/" class="dropdown-item">Backtesting Frameworks</a>
</li>
<li>
<a href="../tutorials/quant-trading/walkforward/" class="dropdown-item">Walk-Forward Validation</a>
</li>
</ul>
</li>
<li class="dropdown-submenu">
<a href="#" class="dropdown-item">Hot Trend Lab</a>
<ul class="dropdown-menu">
<li>
<a href="../tutorials/hot-trend-lab/" class="dropdown-item">Overview</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/" class="dropdown-item">Rendered Notebooks</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/00_hot_trend_lab_overview/" class="dropdown-item">00 Column Overview</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/01_arxiv_category_pulse/" class="dropdown-item">01 arXiv Category Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/02_arxiv_agent_research_pulse/" class="dropdown-item">02 arXiv Agent Research Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/03_huggingface_open_model_pulse/" class="dropdown-item">03 Hugging Face Open-Model Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/04_github_ai_agent_star_velocity/" class="dropdown-item">04 GitHub Star Velocity</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/05_wikipedia_attention_hype_decay/" class="dropdown-item">05 Wikipedia Attention Decay</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/06_crypto_stablecoin_liquidity_pulse/" class="dropdown-item">06 Crypto Stablecoin Liquidity</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/notebooks/07_ai_infrastructure_market_pulse/" class="dropdown-item">07 AI Infrastructure Market Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/data-sources/" class="dropdown-item">Real Data Sources</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/arxiv-research-pulse/" class="dropdown-item">arXiv Research Pulse</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/open-model-and-developer-attention/" class="dropdown-item">Open Models and Developer Attention</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/wiki-market-crypto-attention/" class="dropdown-item">Public Attention, Markets, and Crypto</a>
</li>
<li>
<a href="../tutorials/hot-trend-lab/release-calendar/" class="dropdown-item">Release Calendar</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Gallery</a>
<ul class="dropdown-menu">
<li>
<a href="../gallery/ssa/" class="dropdown-item">SSA</a>
</li>
<li>
<a href="../gallery/std/" class="dropdown-item">STD</a>
</li>
<li>
<a href="../gallery/stdr/" class="dropdown-item">STDR</a>
</li>
<li>
<a href="../gallery/mssa/" class="dropdown-item">MSSA</a>
</li>
<li>
<a href="../gallery/stl/" class="dropdown-item">STL</a>
</li>
<li>
<a href="../gallery/mstl/" class="dropdown-item">MSTL</a>
</li>
<li>
<a href="../gallery/robust-stl/" class="dropdown-item">ROBUST_STL</a>
</li>
<li>
<a href="../gallery/emd/" class="dropdown-item">EMD</a>
</li>
<li>
<a href="../gallery/ceemdan/" class="dropdown-item">CEEMDAN</a>
</li>
<li>
<a href="../gallery/vmd/" class="dropdown-item">VMD</a>
</li>
<li>
<a href="../gallery/wavelet/" class="dropdown-item">WAVELET</a>
</li>
<li>
<a href="../gallery/ma-baseline/" class="dropdown-item">MA_BASELINE</a>
</li>
<li>
<a href="../gallery/mvmd/" class="dropdown-item">MVMD</a>
</li>
<li>
<a href="../gallery/memd/" class="dropdown-item">MEMD</a>
</li>
<li>
<a href="../gallery/gabor-cluster/" class="dropdown-item">GABOR_CLUSTER</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Reference</a>
<ul class="dropdown-menu">
<li>
<a href="../api/" class="dropdown-item">API Overview</a>
</li>
<li>
<a href="../config-reference/" class="dropdown-item">Config Reference</a>
</li>
<li>
<a href="../machine-api/" class="dropdown-item">Machine API</a>
</li>
</ul>
</li>
<li class="nav-item dropdown">
<a href="#" class="nav-link dropdown-toggle" role="button" data-bs-toggle="dropdown" aria-expanded="false">Project</a>
<ul class="dropdown-menu">
<li>
<a href="../comparisons/" class="dropdown-item">Compare Alternatives</a>
</li>
<li>
<a href="../reproducibility/" class="dropdown-item">Reproducibility</a>
</li>
<li>
<a href="../architecture/" class="dropdown-item">Architecture</a>
</li>
<li>
<a href="../migration/" class="dropdown-item">Migration from `tsdecomp`</a>
</li>
<li>
<a href="../contributing/" class="dropdown-item">Contributing</a>
</li>
<li>
<a href="../citation/" class="dropdown-item">Citation / Release Notes</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav ms-md-auto">
<li class="nav-item">
<a href="#" class="nav-link" data-bs-toggle="modal" data-bs-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="nav-item">
<a rel="prev" href=".." class="nav-link">
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li class="nav-item">
<a rel="next" href="../quickstart/" class="nav-link">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
<li class="nav-item">
<a href="https://github.com/systems-mechanobiology/DeTime" class="nav-link">systems-mechanobiology/DeTime</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="col-md-3"><div class="navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
<div class="navbar-header">
<button type="button" class="navbar-toggler collapsed" data-bs-toggle="collapse" data-bs-target="#toc-collapse" title="Table of Contents">
<span class="fa fa-angle-down"></span>
</button>
</div>
<div id="toc-collapse" class="navbar-collapse collapse card bg-body-tertiary">
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="1"><a href="#install" class="nav-link">Install</a>
<ul class="nav flex-column">
<li class="nav-item" data-bs-level="2"><a href="#current-install-path" class="nav-link">Current install path</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#editable-install" class="nav-link">Editable install</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#platform-prerequisites" class="nav-link">Platform Prerequisites</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#native-extension-behavior" class="nav-link">Native extension behavior</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#optional-multivariate-backends" class="nav-link">Optional multivariate backends</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#optional-emd-and-neural-backends" class="nav-link">Optional EMD and neural backends</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#compatibility-alias" class="nav-link">Compatibility alias</a>
<ul class="nav flex-column">
</ul>
</li>
<li class="nav-item" data-bs-level="2"><a href="#troubleshooting-faq" class="nav-link">Troubleshooting FAQ</a>
<ul class="nav flex-column">
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div></div>
<div class="col-md-9" role="main">
<h1 id="install">Install</h1>
<h2 id="current-install-path">Current install path</h2>
<p>Install the latest released package from PyPI:</p>
<pre><code class="language-bash">python -m pip install de-time
</code></pre>
<p>Optional multivariate backends for <code>MVMD</code> and <code>MEMD</code> install with:</p>
<pre><code class="language-bash">python -m pip install "de-time[multivar]"
</code></pre>
<p>Optional EMD-family wrappers for <code>EMD</code> and <code>CEEMDAN</code> install with:</p>
<pre><code class="language-bash">python -m pip install "de-time[emd]"
</code></pre>
<p>Optional torch-backed neural block support for <code>NBEATS_INTERPRETABLE</code> installs with:</p>
<pre><code class="language-bash">python -m pip install "de-time[neural]"
</code></pre>
<p>Notebook tooling for the method gallery installs with:</p>
<pre><code class="language-bash">python -m pip install "de-time[notebook]"
</code></pre>
<p>Names used by this project:</p>
<table>
<thead>
<tr>
<th>Context</th>
<th>Name</th>
</tr>
</thead>
<tbody>
<tr>
<td>Project/product</td>
<td><code>DeTime</code></td>
</tr>
<tr>
<td>Python distribution</td>
<td><code>de-time</code></td>
</tr>
<tr>
<td>Python import</td>
<td><code>detime</code></td>
</tr>
<tr>
<td>Deprecated compatibility alias</td>
<td><code>tsdecomp</code></td>
</tr>
</tbody>
</table>
<p>Do not install the unrelated <a href="https://pypi.org/project/detime/"><code>detime</code></a>
package from PyPI when you want this project; that package is not DeTime.</p>
<p>To install the unreleased <code>main</code> branch directly from GitHub:</p>
<pre><code class="language-bash">python -m pip install "git+https://github.com/systems-mechanobiology/DeTime.git"
</code></pre>
<h2 id="editable-install">Editable install</h2>
<p>Use an editable install for local development, release preparation, or when
you need the unreleased <code>main</code> branch directly from the repository.</p>
<pre><code class="language-bash">python -m pip install --upgrade pip
python -m pip install -e .[dev,docs]
</code></pre>
<p>For optional multivariate wrappers during development:</p>
<pre><code class="language-bash">python -m pip install -e .[dev,docs,multivar]
</code></pre>
<p>For the EMD and torch-backed neural extras during development:</p>
<pre><code class="language-bash">python -m pip install -e .[dev,docs,emd,neural]
</code></pre>
<h2 id="platform-prerequisites">Platform Prerequisites</h2>
<p>Most users will install from wheels and do not need a local compiler. If a
wheel is unavailable and pip falls back to building from source, you need:</p>
<ul>
<li>Python <code>3.10+</code></li>
<li>a working C/C++ toolchain</li>
<li>CMake compatible with the <code>scikit-build-core</code> build</li>
</ul>
<p>Typical source-build prerequisites by platform:</p>
<ul>
<li>Windows</li>
<li>Visual Studio Build Tools with MSVC and CMake on <code>PATH</code></li>
<li>macOS</li>
<li>Xcode Command Line Tools and a working C++17 compiler</li>
<li>Linux</li>
<li>GCC or Clang, Python headers, and CMake</li>
</ul>
<h2 id="native-extension-behavior">Native extension behavior</h2>
<p>DeTime ships native kernels for selected flagship methods:</p>
<ul>
<li><code>SSA</code></li>
<li><code>STD</code></li>
<li><code>STDR</code></li>
</ul>
<p>Backend behavior:</p>
<ul>
<li><code>backend="auto"</code></li>
<li>use native when available, otherwise fall back to Python</li>
<li><code>backend="python"</code></li>
<li>force the Python implementation</li>
<li><code>backend="native"</code></li>
<li>require the native kernel and raise if it is unavailable</li>
</ul>
<p>For <code>SSA</code>:</p>
<ul>
<li><code>speed_mode="exact"</code> uses the deterministic exact decomposition contract</li>
<li><code>speed_mode="fast"</code> uses the approximate iterative path</li>
</ul>
<p>You can inspect the available native exports with:</p>
<pre><code class="language-python">from detime import native_capabilities
print(native_capabilities())
</code></pre>
<h2 id="optional-multivariate-backends">Optional multivariate backends</h2>
<p><code>MVMD</code> and <code>MEMD</code> are optional-backend methods, not core bundled
implementations. They require the <code>multivar</code> extra and currently depend on the
installed <a href="https://pysdkit.readthedocs.io/en/latest/"><code>PySDKit</code></a> backend. The
full method literature and upstream package links live in
<a href="../method-references/">Method References</a>.</p>
<p>If you want reviewer-grade evidence that those wrappers work in your
environment, run:</p>
<pre><code class="language-bash">python examples/optional_multivariate_backends.py
</code></pre>
<h2 id="optional-emd-and-neural-backends">Optional EMD and neural backends</h2>
<p><code>EMD</code> and <code>CEEMDAN</code> require the <code>emd</code> extra because they import PyEMD from the
<code>EMD-signal</code> distribution at runtime. <code>WAVELET</code>, <code>WAVEFORM_BLOCK</code>, and
<code>WAVELETMIXER_BLOCK</code> use PyWavelets, which is part of the default DeTime
dependency set.</p>
<p>Most neural block methods are lightweight NumPy implementations. The exception
is <code>NBEATS_INTERPRETABLE</code>, which requires torch and is installed through the
<code>neural</code> extra.</p>
<h2 id="compatibility-alias">Compatibility alias</h2>
<p>The preferred import is <code>detime</code>. The compatibility scope retained through
<code>0.1.x</code> is limited to:</p>
<ul>
<li>top-level <code>import tsdecomp</code></li>
<li>the <code>tsdecomp</code> executable</li>
<li><code>python -m tsdecomp</code></li>
</ul>
<p>Transition-era submodules such as <code>tsdecomp.backends</code>,
<code>tsdecomp.leaderboard</code>, and <code>tsdecomp.methods.*</code> are intentionally excluded
from install artifacts.</p>
<h2 id="troubleshooting-faq">Troubleshooting FAQ</h2>
<div class="compact-faq">
<details>
<summary>Wrong package installed</summary>
Symptom: `import detime` imports an unrelated package.
Fix: uninstall the unrelated `detime` package, then install `de-time`.
<pre><code class="language-bash">python -m pip uninstall -y detime
python -m pip install de-time
</code></pre>
</details>
<details>
<summary>Native build failed during install</summary>
Symptom: pip attempts a source build and fails in the CMake or compiler stage.
Fix: ensure your platform toolchain is installed, upgrade pip, and retry the
install.
<pre><code class="language-bash">python -m pip install --upgrade pip
python -m pip install --no-cache-dir de-time
</code></pre>
</details>
<details>
<summary>Native backend unavailable at runtime</summary>
Symptom: `backend="native"` raises that the native implementation is
unavailable.
Fix: reinstall from a wheel when available, rebuild locally with a working
compiler toolchain, or use `backend="auto"` / `backend="python"` until the
native path is present.
</details>
<details>
<summary>Optional backend import error</summary>
Symptom: `MVMD`, `MEMD`, `EMD`, `CEEMDAN`, or `NBEATS_INTERPRETABLE` raises an
`ImportError`.
Fix: install the matching extra.
<pre><code class="language-bash">python -m pip install "de-time[multivar]"
python -m pip install "de-time[emd]"
python -m pip install "de-time[neural]"
</code></pre>
</details>
<details>
<summary>Editable install looks stale</summary>
Symptom: schema assets, docs, or native behavior do not match the current
checkout.
Fix: reinstall the editable package after source changes that affect package
data or the native extension.
<pre><code class="language-bash">python -m pip install -e .[dev,docs]
</code></pre>
</details>
</div></div>
</div>
</div>
<footer class="col-md-12">
<hr>
<p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
</footer>
<script src="../js/bootstrap.bundle.min.js"></script>
<script>
var base_url = "..",
shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
</script>
<script src="../js/base.js"></script>
<script src="../search/main.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
<div class="modal-dialog modal-lg">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="searchModalLabel">Search</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>From here you can search these documents. Enter your search terms below.</p>
<form>
<div class="form-group">
<input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
</div>
</form>
<div id="mkdocs-search-results" data-no-results-text="No results found"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<table class="table">
<thead>
<tr>
<th style="width: 20%;">Keys</th>
<th>Action</th>
</tr>
</thead>
<tbody>
<tr>
<td class="help shortcut"><kbd>?</kbd></td>
<td>Open this help</td>
</tr>
<tr>
<td class="next shortcut"><kbd>n</kbd></td>
<td>Next page</td>
</tr>
<tr>
<td class="prev shortcut"><kbd>p</kbd></td>
<td>Previous page</td>
</tr>
<tr>
<td class="search shortcut"><kbd>s</kbd></td>
<td>Search</td>
</tr>
</tbody>
</table>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>
|