fermulerpy / fermulerpy

Repository for the FermulerPy core package. Fermulerpy is useful for problems related to various fields of Number Theory.

Name

FermulerPy

Version

under development

FermulerPy is an open source Python package dedicated to different fields of Number Theory like elementary number theory, analytic number theory, diophantine geomectry, probabilistic number theory, arithmetic combinatorics, etc. It is released under the MIT license.

Documentation

Complete documentation, including a user guide and an API reference, can be read on the wonderful Read the Docs.

https://fermulerpy.readthedocs.io/en/latest/

Problems

If the installation fails or you find something that doesn't work as expected, please open an issue in the issue tracker.

Contributing

FermulerPy is a community project, hence all contributions are more than welcome! For more information, head to CONTRIBUTING.rst.

fermulerpy's Issues

Base conversions

Complete
src>>fermulerpy>>elementary>>other_bases.py

Notebook for Congruences

Create a jupyter notebook for showing usage of congruences submodule in fermulerpy documentation.

How to approach?

1. Head over to docs>>source>>notebooks
2. Create a jupyter notebook for showing usage of congruence submodule of elementary module like present there.

SUM_2_SQUARES submodule

Complete this module in elementary

Gauss Dirichlet sum

Complete the function for gauss sum for Dirichlet characters mod k.

src - fermulerpy - analytic - arithmetic_periodic.py

Can be completed only after the completion of Dirichlet character generator

irrelevant file in test folder for constant module

In test>>test_constants , file named f.py is empty and can be deleted

Perfect number submodule

Functions related to perfect numbers needs to be added in
src>>fermulerpy>>elementary>>perfect_numbers.py

Add logo of fermulerpy in README.rst

Logo of fermulerpy can be found at the repository LOGO
Add that logo in README.rst at the top

write tests for elementary>>other_bases

configure docs to display info about all functions of fermulerpy

write tests for elementary>>factorization

Brute force test addition in test_elementary module

There should be atleast 2 tests for checking a prime number based on brute force method. They can be named as "test_isPrime3()" and "test_prime4()".
Important note:

1. Tests should be performed on large numbers (numbers havng atleast 10 digits).
2. Coding style should be strictly folllowed.

Add function names in analytics

Go to src >> fermulerpy >> analytic >> init.py

Complete it in same way as has been done in src >> fermulerpy >> elementary >> init.py

write tests for elementary>>sum_2_squares

Duodecimals functions

Complete
src>>fermulerpy>>elementary>>duodecimals.py

write tests for elementary>>fermat and wilson

write tests for elementary>>linear_diophantine

write tests for elementary>>quadratic_congruences

Quadratic Congruences

src>>fermulerpy>>elementary>>quadratic_congruences.py

Function for calculating solutions of quadratic congruences

write tests for analytic>>dirichlet.py

write tests for elementary>>euler

Integer solutions for diophantine equations

In src>>fermulerpy>>elementary>>linear_diophantine.py

There must be the function for calculating integers solutions for given diophantine equation (just like rational solutions)

Add function names in combinatorics

Go to src >> fermulerpy >> combinatorics >> init.py

Complete it in same way as has been done in src >> fermulerpy >> elementary >> init.py

Dirichlet character table generator

Go to src>>fermulerpy>>analytic>>dirichlet.py
Complete the function for generating dirichlet character table generator

Tests for contant module

As of now, tests for constant modules have not been added. They can be added in tests >> test_constants. In the test_constants directory rename the file f.py to test_useful_series.py
Then add at least 4 tests for each function present in src>>fermulerpy>>constants>>useful_series.py
You can take help from the tests implemented in test>>test_elementary directory.

write tests for elementary>>congruences

Complete the commented functions

Go to constants submodule in src>>fermulerpy and complete commented functions in file useful_series.py

write tests for elementary>>linear_congruences

Update CONTRIBUTING.rst

Currently, there are no instructions present in the constributing.rst file to build , run and test the package. Only, instructions related to docs build are present. We need to add package build, run and testing instructions.

Wrong warnings in constant submodule

In src>>fermulerpy>>constants>>useful_series.py, NotImplementedError should be replaced with ValueError at all places.

missing package in requirements_dev.txt

pytest package should be added in this list as it has been used to perform testing of package

write tests for elementary>>primitive

write tests for elementary>>perfect_numbers

Missing package installation instructions in documentation

In FermulerPy documentation, the section having info about current method of installation does not contain instructions for installing bdist_wheel.

write tests for elementary>>divisors

write tests for elementary>>pythagorean_triangles

write tests for elementary>>decimals

Conductor of Dirichlet character

Complete the function for calculating conductor for Dirichlet characters mod k.

src - fermulerpy - analytic - arithmetic_periodic.py

Can be completed only after the completion of Dirichlet character generator

Jupyter notebooks for examples

Add jupyter notebooks for showing the usefulness of modules

decimal related functions

Complete
src>>fermulerpy>>elementary>>decimals.py

primitive roots

src>>fermulerpy>>elementary>>primitive.py

Function for calculating primitive roots

Wrong answer for large inputs for LCM