PiDigitsCalculator

A Python project that calculates and displays the digits of the mathematical constant π (pi) with precision. Customize the number of decimal places and interactively view the digits. Includes pause, and stop features for a seamless user experience.

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Features
• Contributing
  • Code of Conduct
  • How to Contribute
  • Code Style
  • Testing
• License
• Contact

About

The PiDigitsCalculator is a Python project designed to calculate and display the digits of the mathematical constant π (pi) with a high degree of precision. It offers users the flexibility to customize the number of decimal places they want to calculate, and it provides an interactive interface for viewing the calculated digits. Whether you're interested in exploring the beauty of pi or need a high-precision pi calculator for your projects, PiDigitsCalculator has you covered.

Getting Started

To get started with the PiDigitsCalculator, follow these steps:

Prerequisites

Before using the PiDigitsCalculator, make sure you have the following prerequisites installed on your system:

• Python: You need Python installed on your computer. You can download and install Python from the official Python website at python.org.

Installation

1. Clone the PiDigitsCalculator repository to your local machine using Git. Open your terminal or command prompt and run the following command:

   git clone https://github.com/LightAndy1/PiDigitsCalculator

2. Navigate to the project directory:

   cd PiDigitsCalculator

3. Install the requirements by running the following command:

   pip install -r requirements.txt

Usage

After the installation process, you can run the following command: python calculate_pi.py

Features

List the key features of your project, making it clear what sets it apart.

• Calculate pi with high precision.
• Customize the number of decimal places.
• Interactive features (pause and stop).
• Caching to avoid redundant calculations.

Contributing

We welcome contributions from the open-source community to help improve and grow the PiDigitsCalculator project. By contributing, you can make a positive impact and collaborate with other developers.

Before you start contributing, please take a moment to review the following guidelines:

Code of Conduct

We encourage respectful and inclusive behavior within the PiDigitsCalculator community.

How to Contribute

1. Fork the Repository: Click the "Fork" button on the top right of the repository to create your own fork.

2. Clone Your Fork: Clone your forked repository to your local machine:

   git clone https://github.com/LightAndy1/PiDigitsCalculator

3. Create a Branch: Create a new branch for your contribution. Naming your branch appropriately is appreciated:

   git checkout -b feature/your-feature-name

4. Make Changes: Make your changes or improvements to the codebase.

5. Commit Changes: Commit your changes with a clear and descriptive commit message:

   git commit -m "Add your descriptive commit message here"

6. Push Changes: Push your branch to your fork on GitHub:

   git push origin feature/your-feature-name

7. Submit a Pull Request: Go to the original repository on GitHub and create a new Pull Request (PR) to submit your changes for review. Please provide a clear and informative description of your PR.

Code Style

We follow a specific coding style in this project. Please make sure your code adheres to this style to ensure consistency and readability.

Testing

If your contribution includes new features or code changes, please add appropriate tests and ensure that existing tests pass.

License

This project is licensed under the [GNU GPLv3] - see the LICENSE file for details. By contributing to this project, you agree to release your contributions under the GNU GPLv3 License. Make sure you understand and accept the terms of the license before contributing.

Contact

• Light Andy - [[email protected]]
• Project Link: GitHub