Z2n Periodogram

A program for interative periodograms analysis!
Explore the docs »

View Demo · Report Bug · Request Feature

About the Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License

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.

Python

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  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.

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

License

Metadata

Release files for z2n-periodogram 1.7.2

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.7.2
File	Size	Uploaded
z2n-periodogram-1.7.2.tar.gz	15.9 kB	Jun 12, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for z2n-periodogram 1.7.2
File	Interpreter	ABI	Platform	Reset
z2n_periodogram-1.7.2-py3-none-any.whl 19.3 kB Jun 12, 2020	Python 3	none	any	Details

Total release size: 35.2 kB

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

Download URL	z2n-periodogram-1.7.2.tar.gz
Size	15.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`fcb0dbdb300fc84b1143c72e47fc72553b187ec1684175e0e9043ff6ed9f77b7`
BLAKE2b-256 checksum How to use checksums	`d1b1218ebb1e563bbdcf1b7568ae52335373fb76a97a2dea71f8da8994f63885`
Upload date	Jun 12, 2020
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.7.2-py3-none-any.whl

Download URL	z2n_periodogram-1.7.2-py3-none-any.whl
Size	19.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`1b3bd4748f1bfccf7fcec855645c772fb13f25604b6908e490b68447b585f71d`
BLAKE2b-256 checksum How to use checksums	`f6ca28dc92c7b4358298099de9b22e8d9ee06a1647113a895e71a97e0ce2cf0e`
Upload date	Jun 12, 2020
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`