Skip to main content

PyPI GitHub issues GitHub Documentation Status


Logo

Z2n Periodogram

A program for interative periodograms analysis!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

The Z2n Software was developed by Yohan Alexander as a research project, funded by the CNPq Institution, and it is a Open Source initiative. The program allows the user to calculate periodograms using the Z2n statistics a la Buccheri et al. 1983, which is defined as follows.

\Large \phi_j [0,1] = frac(v_i\Delta t_{ij} + \dot v_i \frac{\Delta t^2_{ij}}{2} + \dot v_i \frac{\Delta t^3_{ij}}{6})

\Large Z^2_n = \frac{2}{N} \cdot \sum_{k=1}^{n} [(\sum_{j=1}^{N} cos(k\phi_j)) ^ 2 + (\sum_{j=1}^{N} sin(k\phi_j)) ^ 2]

The standard Z2n statistics calculates the phase of each photon and the sinusoidal functions above for each photon. Be advised that this is very computationally expensive if the number of photons is high, since the algorithm grows at a exponential rate \large O(n^2).

Built With

The Z2n Software was built using the Python open source language.

Getting Started

Prerequisites

The version of the Python interpreter used during the development was the3.7, which can be managed in virtual environments such as Anaconda. Therefore, try to use the same or above versions for the best compatibility.

  • Python>=3.7
  • PIP

Installation

The software is currently hosted at the Python central repository PyPI, to install the software properly use the terminal command:

pip install z2n-periodogram

Usage

To start the software just type z2n on the terminal (check if you're under the virtual environment that it is installed).

z2n

The CLI of the software is very interactive and it works by triggering the commands available, for more information on the usage type help.

        Z2n Software, a program for interactive periodograms analysis.
        Copyright (C) 2020, and MIT License, by Yohan Alexander [UFS].
        Type "help" for more information or "docs" for documentation.

(z2n) >>> help

Documented commands (type help <topic>):
========================================
docs  log  plot  run  save

Undocumented commands:
======================
exit  help  quit

(z2n) >>>

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

All content © 2020 Yohan Alexander. Distributed under the MIT License. See LICENSE for more information.

Metadata

Release files for z2n-periodogram 1.8.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for z2n-periodogram 1.8.5
File Size Uploaded Provenance Actions
z2n-periodogram-1.8.5.tar.gz 18.2 kB Without provenance Details for z2n-periodogram-1.8.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for z2n-periodogram 1.8.5
File Interpreter ABI Platform Actions
z2n_periodogram-1.8.5-py3-none-any.whl Python 3 none any Details for z2n_periodogram-1.8.5-py3-none-any.whl

Total release size: 39.8 kB

Release files / z2n-periodogram-1.8.5.tar.gz

Download URL z2n-periodogram-1.8.5.tar.gz
Size 18.2 kB
Tags Source
SHA-256 checksum
How to use checksums
58d4c074285f64037f3bc2701e186212a5024bf1c341881abe11d109ad411921
BLAKE2b-256 checksum
How to use checksums
4814dcbe12692c1a53bcdb210b960c60b91cf6da67b552b369f7db2eb8ba77f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Release files / z2n_periodogram-1.8.5-py3-none-any.whl

Download URL z2n_periodogram-1.8.5-py3-none-any.whl
Size 21.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7ffc97715a7a9ebb25d6e2a0726527b534df037cf8e53e47c7167c4609ea7410
BLAKE2b-256 checksum
How to use checksums
a7b61fd90424da1eb9a1260afa5ca4d29eeaf7f7ff65871378ee1564ba9db2ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.4.0.post20200518 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.7

Security for z2n-periodogram 1.8.5

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.

Release history Release notifications | RSS feed

This release

1.8.5 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page