ferro

A python package to ease manipulation of ferroelectric (and perhaps ferromagnetic) test data. Includes experimental modeling capabilities.

https://github.com/janderson419/ferro

Science Score: 54.0%

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

  • CITATION.cff file
    Found 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
    2 of 5 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (5.1%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

A python package to ease manipulation of ferroelectric (and perhaps ferromagnetic) test data. Includes experimental modeling capabilities.

Basic Info
  • Host: GitHub
  • Owner: JAnderson419
  • License: other
  • Language: Python
  • Default Branch: master
  • Size: 18.8 MB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 6
  • Open Issues: 6
  • Releases: 4
Created almost 9 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog License Citation

README.md

Ferro

Documentation Status

Master:

Build Status codecov badge

Dev:

Build Status codecov badge

Ferro aims to be a python package to ease manipulation of ferroelectric (and perhaps ferromagnetic) test data. It includes a HysteresisData class for read-in, storage, and display of PV/PUND/IV measurements as well as the beginning of a Landau modeling class (work in progress) that currently has a simple Presiach model implemented. If you would like to use some portion of this for your research (or add on features), I would be happy to help you get started. Tutorial notebooks are available on binder at the link above, or can be build locally following instructions in the README in the tutorial folder.

Docstrings are in numpy style. For an example of a complete device analysis, see Ferro/bin/multidomainAnalysis.py

For an overview of the role of each function beyond the docstrings, see chapter 3 of "Measurement of Ferroelectric Films in MFM and MFIS Structures" by J. Anderson, available online: http://scholarworks.rit.edu/theses/9547/. Note that this work uses old syntax - the code has since been refactored to use more standard python syntax for classes and function/method names. Functionality, however, remains the same.

Developed on python 3.5 and 3.6 using Anaconda. If downloading from Github, be sure to use pip to install the package to ensure you have the proper prerequisites. If you have any questions, please contact me.

Jackson

Owner

  • Name: Jackson Anderson
  • Login: JAnderson419
  • Kind: user
  • Company: Purdue University

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Anderson"
  given-names: "Jackson"
  orcid: "https://orcid.org/0000-0001-8898-6967"
- family-names: "Tran"
  given-names: "Huy Minh"
title: "Ferro"
date-released: 2021
url: "https://github.com/JAnderson419/Ferro"

GitHub Events

Total
  • Watch event: 1
  • Fork event: 1
Last Year
  • Watch event: 1
  • Fork event: 1

Committers

Last synced: about 3 years ago

All Time
  • Total Commits: 181
  • Total Committers: 5
  • Avg Commits per committer: 36.2
  • Development Distribution Score (DDS): 0.271
Top Committers
Name Email Commits
Jackson Anderson j****3@r****u 132
Jackson Anderson b****9@g****m 42
Minios0903 t****1@g****m 5
kbenara k****2@g****u 1
fossabot b****s@f****o 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 9
  • Total pull requests: 19
  • Average time to close issues: 2 days
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 4
  • Average comments per issue: 0.11
  • Average comments per pull request: 0.95
  • Merged pull requests: 18
  • 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
  • JAnderson419 (8)
  • RyPeck (1)
Pull Request Authors
  • JAnderson419 (14)
  • Minios0903 (3)
  • fossabot (1)
  • Makva08 (1)
Top Labels
Issue Labels
enhancement (4) bug (1) good first issue (1) help wanted (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 42 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 3
  • Total maintainers: 1
pypi.org: ferro

Manipulation and Modeling of Ferroelectric Test Data

  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 42 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 14.2%
Dependent repos count: 21.6%
Average: 23.9%
Stargazers count: 27.8%
Downloads: 45.7%
Maintainers (1)
Last synced: 8 months ago

Dependencies

dev-requirements.txt pypi
  • bumpversion * development
  • sphinx * development
  • twine * development
setup.py pypi
  • matplotlib *
  • mpldatacursor *
  • numpy *
  • scipy *
tutorial/tut-requirements.txt pypi
  • jupyter *
  • jupytext *
docs/requirements.txt pypi