NFF — Normalized Factor Flow
Python package migration scaffold for Elxrth/NFF-normalized-factor-flow.
Important status: this archive provides the packaging layout, installation metadata, tests, command-line entry point, and reusable data utilities. It does not contain the original
main.pyanalysis implementation. The source file could not be retrieved while preparing this ZIP, so no NUA, normalization, signature, or ORDER formula has been recreated or guessed. FollowINTEGRATION.mdto integrate the actual engine before publishing a functional NFF release to PyPI.
Requirements
- Python 3.10 or newer
- NumPy 1.24 or newer
- PyTorch is an optional extra in this scaffold; install it when integrating/running the original PyTorch engine.
Install for development
git clone https://github.com/Elxrth/NFF-normalized-factor-flow.git
cd NFF-normalized-factor-flow
python -m venv .venv
Windows PowerShell:
.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
python -m pip install -e ".[dev,engine]"
Linux / macOS:
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e '.[dev,engine]'
For a CUDA-enabled PyTorch build, install the build matching your CUDA/runtime from the
official PyTorch install selector before installing
this project with --no-deps, or adjust the project extras to your supported CUDA index.
Current utility API
import nff
import numpy as np
flow = nff.Flow(np.sin(np.linspace(0, 10, 2_000)), name="sensor", sampling_rate=100)
containers = nff.create_containers(flow.data, size=256, stride=128)
normalized = nff.normalize(containers[0], method="zscore")
print(len(flow))
print(normalized[:5])
Available utilities:
| API | Purpose |
|---|---|
nff.Flow(data) |
Validated one-dimensional numeric flow |
nff.create_containers(data, size, stride=...) |
Split a stream into temporal windows |
nff.normalize(data, method=...) |
Generic z-score, min-max, or robust scaling |
nff.compare_signatures(a, b, metric=...) |
Generic cosine / Euclidean / Manhattan comparison |
nff.load_csv(path, column=0) |
Load a numeric CSV column |
nff.load_numpy(path) |
Load a .npy array |
nff.export_json(data, path) |
Export structured data to JSON |
nff.export_csv(data, path) |
Export a numeric vector to CSV |
nff.NFFEngine(...).analyze(flow) |
Reserved for the original NFF engine; pending integration |
The generic normalization and comparison helpers are convenience utilities. They are not claims about the project's canonical NFF normalization or signature-comparison definitions.
CLI
nff --version
nff info
nff doctor
Tests
python -m pytest
Build distributions
python -m pip install --upgrade build twine
python -m build
twine check dist/*
Do not upload this scaffold to PyPI as a finished NFF release until the original algorithm is integrated, tests cover its documented outputs, and the license metadata has been verified.
PyPI publication
- Confirm that the distribution name
nff-normalized-factor-flowis available on PyPI. - Integrate the original engine and complete the tests (see
INTEGRATION.md). - Verify the real license and author metadata.
- Build and validate the distributions with the commands above.
- Test on TestPyPI, then publish with
twine upload dist/*or configure PyPI Trusted Publishing.
Project source and theory: https://github.com/Elxrth/NFF-normalized-factor-flow
Metadata
Release files for nff-normalized-factor-flow 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| nff_normalized_factor_flow-0.1.0.tar.gz | 10.5 kB | Without provenance | Details for nff_normalized_factor_flow-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| nff_normalized_factor_flow-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for nff_normalized_factor_flow-0.1.0-py3-none-any.whl |
Total release size: 21.0 kB
Release files / nff_normalized_factor_flow-0.1.0.tar.gz
| Download URL | nff_normalized_factor_flow-0.1.0.tar.gz |
|---|---|
| Size | 10.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1d807502c0ab1cc6bcc77645e5eccc784e1150eabb73f775128159ee287c686e
|
|
BLAKE2b-256 checksum How to use checksums |
12fcbb3169662c8fd347199f7b80e249d80789e0434fbf62583f11e618e39857
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.7
|
Release files / nff_normalized_factor_flow-0.1.0-py3-none-any.whl
| Download URL | nff_normalized_factor_flow-0.1.0-py3-none-any.whl |
|---|---|
| Size | 10.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
20efa36b20919281a74afeabe26d3bec5b2a5c3de838b496402bfa7b7a39c0aa
|
|
BLAKE2b-256 checksum How to use checksums |
d68a9af88a1c254b47b741a6d2a1b912e6a294bb35dec3ed192a20b7a0a6ced8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.7
|
Security for nff-normalized-factor-flow 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.