https://github.com/fgittins/mullerpy

A Python implementation of Muller's method.

https://github.com/fgittins/mullerpy

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.9%) to scientific vocabulary
Last synced: 8 months ago · JSON representation

Repository

A Python implementation of Muller's method.

Basic Info
  • Host: GitHub
  • Owner: fgittins
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 806 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 4
Created over 2 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

mullerpy logo

PyPI version

mullerpy

A Python implementation of Muller's method.


Usage

This library requires no dependencies beyond the Python standard library.

Here is a quick example to show how it is used:

```python from mullerpy import muller from math import exp, sin

def f(x): return exp(-x) * sin(x)

xguesses = (-1, 0, 1) res = muller(f, xguesses)

print(res.root) ```

This finds a root of the function

$$ f(x) = e^{-x} \sin(x), $$

which has roots at $x = n \pi$ for integer $n$. The result object has a .root attribute storing the estimated solution.

Installation

It is easy to install mullerpy with pip:

pip install mullerpy

Testing

To test, run

python -m unittest tests.test_muller

in the root directory. I like to use pytest, where you can simply enter

pytest

Owner

  • Name: Fabian Gittins
  • Login: fgittins
  • Kind: user
  • Location: Southampton
  • Company: University of Southampton

Research fellow at the STAG Research Centre, University of Southampton. Currently spinning a lot of neutron stars.

GitHub Events

Total
  • Release event: 2
  • Push event: 7
  • Fork event: 1
  • Create event: 1
Last Year
  • Release event: 2
  • Push event: 7
  • Fork event: 1
  • Create event: 1

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 8
  • Total Committers: 1
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 8
  • Committers: 1
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Fabian Gittins f****s@g****m 8

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 13 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
  • Total maintainers: 1
pypi.org: mullerpy

A Python implementation of Muller's method.

  • Documentation: https://mullerpy.readthedocs.io/
  • License: MIT License Copyright (c) 2023 Fabian Gittins Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 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.
  • Latest release: 0.1.1
    published 12 months ago
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 13 Last month
Rankings
Dependent packages count: 9.0%
Average: 29.9%
Dependent repos count: 50.8%
Maintainers (1)
Last synced: 8 months ago

Dependencies

pyproject.toml pypi