Z2n Periodogram

A package for interative periodograms analysis!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

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 .

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