Skip to content

Latest commit

 

History

History
 
 

README.md

Math Folder

This folder contains Python mini-projects focused on math concepts, number patterns, calculators, and transformations. Each project is in its own subfolder and can be run directly from the terminal.

Projects in math/

  • AP-GP-AGP-HP-Recognizer
  • Armstrong-Number
  • Caesar-Cipher
  • Collatz-Conjecture
  • Coordinate-to-Polar-Transformation
  • Derivative-Calculator
  • Fibonacci-Series
  • Happy-Number
  • Matrix-Calculator
  • Pascal-Triangle
  • Prime-Number-Analyzer
  • Projectile-Motion-Game
  • Simple-Calculator

How to Set Up and Run Any Math Project

Follow these steps to run any project in the math folder. These instructions are designed for beginners and assume no prior experience with Python projects.

1. Install Python (if not already installed)

You need Python 3.10 or higher. Download it from the official website: https://www.python.org/downloads/

After installing, check your version:

python --version
# or
python3 --version

If you see a version number like Python 3.10.0 or higher, you are ready.

2. Open a Terminal or Command Prompt

On Windows: Press Win + R, type cmd, and press Enter. On Mac: Open the Terminal app from Applications > Utilities. On Linux: Open your preferred terminal emulator.

3. Navigate to the Project Folder

Use the cd command to change directories. For example, to go to the Fibonacci-Series project:

cd path/to/your/python-mini-project/math/Fibonacci-Series

Replace path/to/your/python-mini-project with the actual path where you downloaded or cloned the repository.

4. (Optional) Install Project Dependencies

Most math projects use only the Python standard library and do not require extra packages. If a project folder contains a requirements.txt file, install dependencies with:

pip install -r requirements.txt
# or
pip3 install -r requirements.txt

If you get a 'pip not found' error, try python -m pip install -r requirements.txt instead.

5. Run the Project

Start the project by running its main Python file. For example:

python Fibonacci-Series.py
# or
python3 Fibonacci-Series.py

If you get an error about 'python' not being found, try 'python3'.

6. Read Project-Specific Instructions

Some projects may include a README file or comments at the top of the code. Always check for these files in the project folder for details on how to use the tool, what input it expects, and what output it produces.

7. Troubleshooting

  • If you see an error about missing modules, double-check step 4.
  • If you see a 'Permission denied' error, make sure you have permission to access the folder and files.
  • If you are stuck, open an issue on the repository or ask for help in the project's discussion area.

Best Practices for Contributors

  • Keep logic clear and beginner-friendly.
  • Add comments for educational value and to explain non-obvious code sections.
  • Follow existing folder and file naming conventions.
  • Add concise input/output instructions if you create new math tools (in README or code comments).
  • Avoid adding unnecessary dependencies. If dependencies are required, always include a requirements.txt file and update instructions.
  • Use clear, descriptive variable and file names.
  • Test your project on Windows, Mac, and Linux if possible.

Credit: Project by steam-bell-92 and contributors