dynamic-diffraction-module

v0.1.0

A python based framework for dynamic diffraction calculations of crystals. For more information about how to use this package see README

Latest version published 1 year ago

License: GPL-3.0

PyPI

GitHub

Package Health Score

46 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Limited

GitHub Stars: 129
Forks: 56
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package dynamic-diffraction-module, we found that it has been starred 129 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Jul 14, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like dynamic-diffraction-module is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 9
Open PR: 1
Last Release: 1 year ago
Last Commit: 1 month ago

Further analysis of the maintenance status of dynamic-diffraction-module based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for dynamic-diffraction-module is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: Yes

With more than 10 contributors for the dynamic-diffraction-module repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like dynamic-diffraction-module is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7.1,<4.0

Age: 1 year
Latest Release: 1 year ago
Dependencies: 6 Direct / 14 Total
Versions: 1
Maintainers: 1
Wheels: OS Independent

Readme

Dynamic Diffraction Module

A repository meant for (python based) functions on the dynamic diffraction theory. It is closely related to the Matlab written . The structure, however, is based on the Dynamic Diffraction submodule of the pXCP framework.

Documentation:
GitLab:
PyPI:

Features

Currently, the scope of the package is rather rudimentary. It includes:

computing the (modified) Bragg energy for any given plane H for a specific micro- and macroscopic crystal orientation
computing the (approximative) energy width for any given plane H for a specific micro- and macroscopic crystal orientation in the two beam approximation
Selecting the number of reflecting planes in the vicinity of a given photon energy + crystal orientation configuration
computing reflectivity/transmissivity vs energy for a specified crystal plane H0 can be computed in the two beam approximation
Rocking curve scans in the two beam approximation

However, further functionality is to follow soon:

n-beam diffraction
diffraction at strained crystals
...

External packages

numpy (required)
xraylib (prospectively optional,currently required)
matplotlib
pandas

Usage

There is no documentation for the API yet. However, you can find some tutorial *.ipynb scripts in the playgrounds folder on gitlab.

LICENSE

Free software: GNU GENERAL PUBLIC LICENSE Version 3

Credits

This package was created with Cookiecutter and the waynerv/cookiecutter-pypackage project template.

dynamic-diffraction-module dependencies

black matplotlib numpy pandas scipy xraylib

FAQs

What is dynamic-diffraction-module?

A python based framework for dynamic diffraction calculations of crystals. Visit Snyk Advisor to see a full health score report for dynamic-diffraction-module, including popularity, security, maintenance & community analysis.

Is dynamic-diffraction-module popular?

The python package dynamic-diffraction-module receives a total of 22 weekly downloads. As such, dynamic-diffraction-module popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is dynamic-diffraction-module well maintained?

We found indications that dynamic-diffraction-module is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is dynamic-diffraction-module safe to use?

While scanning the latest version of dynamic-diffraction-module, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 November-2024, at 08:17 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP