pyintegral 0.0.13

PyIntegral

A Fortran legacy package to easy integrate numerically

email: antineutrinomuon@gmail.com, jean@astro.up.pt

© Copyright ®

J.G. - Jean Gomes

last stable version: 0.0.13

---

---

---

RESUME

Integrate arrays, functions numerically using different methods. Original Fortran 2003+ routines date back to 2003-2004. Read the LICENSE.txt file. Definite integrals are mathematical calculations that allow us to find the area under a curve between two defined points on the x-axis. In other words, they give us the total accumulated value of a function over an interval. Definite integrals are used in various fields, such as physics, engineering, and finance, to solve real-world problems, such as calculating the total distance travelled by a moving object or the total profit of a company over a certain period.

There are various techniques for computing definite integrals, including analytical methods (e.g., antiderivatives) and numerical methods (e.g., using quadrature or Monte Carlo). The choice of method depends on the type of function being integrated, the desired accuracy, and the computational resources available. Some commonly used numerical integration techniques include the trapezoidal rule, Simpson's rule, and Gaussian quadrature.

In computer programming, definite integrals can be calculated using specialized libraries and routines that provide numerical integration algorithms. These routines typically take as input the function to be integrated, the interval over which to integrate, and the desired level of accuracy. The output of the routine is an approximation of the definite integral.

$\color{#58A6FF}\textsf{\Largeⓘ\kern{0.2cm}\normalsize Note}$

This project was also created with a focus on educational purposes.

Now, PyIntegral has all its scripts in accordance with PEP 8 guidelines.

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

---

INSTALLATION

You can easily install PyIntegral by using pip - PyPI - The Python Package Index:

pip install PyIntegral

or by using a generated conda repository https://anaconda.org/neutrinomuon/PyIntegral:

conda install -c neutrinomuon PyIntegral

OBS.: Linux, OS-X ad Windows pre-compilations available in conda.

You can also clone the repository and install by yourself in your machine:

git clone https://github.com/neutrinomuon/PyIntegral
python setup.py install

---

METHODS

The methods are given by Int_Type and may be summarized bellow:

Int_Type	Type	Description
0	R	Right rectangle Integral
1	L	Left rectangle Integral
2	T	Trapezoidal rule
3	S	Simple Integral
4	M	Median rectangle Integral
5	I	Simpsonregel's rule
6	G	Gauss-Legendre Quadrature

---

REFERENCES

William H. Press, Saul A. Teukolsky, William T. Vetterling, and Brian P. Flannery. Numerical Recipes: The Art of Scientific Computing. William ISBN: 978-0521880688. Link: https://www.nr.com/

---

STRUCTURE

The main structure of the directories and files are:

#################################################
PyIntegral
├── PyIntegral
│   ├── win-32
│   ├── linux-armv7l
│   ├── win-arm64
│   ├── linux-armv6l
│   ├── linux-s390x
│   ├── linux-ppc64
│   ├── linux-aarch64
│   ├── linux-32
│   ├── linux-64
│   ├── osx-64
│   ├── meta.yaml
│   ├── win-64
│   ├── README.txt
│   ├── linux-ppc64le
│   └── osx-arm64
├── dist
│   └── pyintegral-0.0.12.2.tar.gz
├── README.md
├── showdown.min.js
├── figures
│   ├── Definite_Integral.png
│   ├── Example_Integration.png
│   ├── PyIntegral.png
│   ├── PEP8-StyleGuide.jpg
│   └── Education,_Studying,_University,_Alumni_-_icon.png
├── .github
│   └── workflows
├── scripts
│   └── update_readme.py
├── index.html
├── LICENSE.txt
├── setup.py
├── tutorials
│   ├── Definite_Integral.png
│   ├── Definite_Integral.py
│   ├── .ipynb_checkpoints
│   ├── example1_pyintegral.ipynb
│   ├── .virtual_documents
│   └── README.txt
├── src
│   ├── python
│   └── fortran
├── .DS_Store
├── version.txt
├── pyintegral.egg-info
│   ├── PKG-INFO
│   ├── dependency_links.txt
│   ├── SOURCES.txt
│   ├── top_level.txt
│   └── requires.txt
├── README_setup.txt
├── requirements.txt
├── build
│   ├── lib.linux-x86_64-cpython-39
│   ├── lib.macosx-11.1-arm64-cpython-39
│   ├── temp.macosx-11.1-arm64-cpython-39
│   ├── temp.linux-x86_64-cpython-39
│   ├── src.linux-x86_64-3.9
│   ├── temp.linux-x86_64-3.9
│   └── src.macosx-11.1-arm64-3.9
└── .git
    ├── branches
    ├── logs
    ├── info
    ├── index
    ├── description
    ├── FETCH_HEAD
    ├── HEAD
    ├── ORIG_HEAD
    ├── objects
    ├── packed-refs
    ├── hooks
    ├── COMMIT_EDITMSG
    ├── refs
    └── config

41 directories, 35 files
#################################################
Generated with tree_colored @ 2023 - © Jean Gomes
#################################################

PyIntegral.py is a python wrapper to the library in Fortran called pyintegral.flib. The Fortran directory can be compiled separately for each individual subroutine.

---

ISSUES AND CONTRIBUTIONS

If you encounter any issues with this project, please feel free to submit an issue on the GitHub repository. We appreciate your feedback and are committed to improving the quality of our codebase.

If you'd like to contribute to this project, we welcome pull requests from the community. Before submitting a pull request, please make sure to fork the repository and create a new branch for your changes. Once your changes are complete, submit a pull request and we'll review your code as soon as possible.

For any questions or concerns about contributing, please contact the project maintainer at antineutrinomuon@gmail.com. Thank you for your interest in contributing to our project!

---

LICENSE

This software is provided "AS IS" (see DISCLAIMER below). Permission to use, for non-commercial purposes is granted. Permission to modify for personal or internal use is granted, provided this copyright and disclaimer are included in ALL copies of the software. All other rights are reserved. In particular, redistribution of the code is not allowed without explicit permission by the author.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.