k-Wave-python

v0.3.4

Acoustics toolbox for time domain acoustic and ultrasound simulations in complex and tissue-realistic media. For more information about how to use this package see README

Latest version published 4 months ago

License: GPL-3.0

PyPI

GitHub

Package Health Score

72 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Active

Popularity

Limited

GitHub Stars: 105
Forks: 31
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package k-Wave-python, we found that it has been starred 105 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Jul 9, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
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 k-Wave-python 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

Sustainable

Commit Frequency

Open Issues: 36
Open PR: 16
Last Release: 4 months ago
Last Commit: 7 days ago

Further analysis of the maintenance status of k-Wave-python based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that k-Wave-python demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

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

With more than 10 contributors for the k-Wave-python 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 k-Wave-python 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.9

Age: 3 years
Latest Release: 4 months ago
Dependencies: 0 Direct
Versions: 9
Maintainers: 1
Wheels: OS Independent

Readme

k-Wave-python

This project is a Python implementation of v1.4.0 of the MATLAB toolbox k-Wave as well as an interface to the pre-compiled v1.3 of k-Wave simulation binaries, which support NVIDIA sm 5.0 (Maxwell) to sm 9.0a (Hopper) GPUs.

Mission

With this project, we hope to increase the accessibility and reproducibility of k-Wave simulations for medical imaging, algorithmic prototyping, and testing. Many tools and methods of k-Wave can be found here, but this project has and will continue to diverge from the original k-Wave APIs to leverage pythonic practices.

Getting started

A large collection of examples exists to get started with k-wave-python. All examples can be run in Google Colab notebooks with a few clicks. One can begin with e.g. the B-mode reconstruction example notebook.

This example file steps through the process of:

Generating a simulation medium
Configuring a transducer
Running the simulation
Reconstructing the simulation

Installation

To install the most recent build of k-Wave-python from PyPI, run:

pip install k-wave-python

After installing the Python package, the required binaries will be downloaded and installed the first time you run a simulation.

Development

If you're enjoying k-Wave-python and want to contribute, development instructions can be found here.

Related Projects

k-Wave: A MATLAB toolbox for the time-domain simulation of acoustic wave fields.
j-wave: Differentiable acoustic simulations in JAX.
ADSeismic.jl: a finite difference acoustic simulator with support for AD and JIT compilation in Julia.
stride: a general optimisation framework for medical ultrasound tomography.

Documentation

The documentation for k-wave-python can be found here.

Citation

@software{k-Wave-Python,
author = {Yagubbbayli, Farid and Sinden, David and Simson, Walter},
license = {GPL-3.0},
title = {{k-Wave-Python}},
url = {https://github.com/waltsims/k-wave-python}
}

Contact

e-mail wsimson@stanford.edu.

FAQs

What is k-Wave-python?

Acoustics toolbox for time domain acoustic and ultrasound simulations in complex and tissue-realistic media. Visit Snyk Advisor to see a full health score report for k-Wave-python, including popularity, security, maintenance & community analysis.

Is k-Wave-python popular?

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

Is k-Wave-python well maintained?

We found indications that k-Wave-python maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is k-Wave-python safe to use?

The python package k-Wave-python was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 November-2024, at 04:40 (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

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

k-Wave-python

Mission

Getting started

Installation

Development

Related Projects

Documentation

Citation

Contact

FAQs

What is k-Wave-python?

Is k-Wave-python popular?

Is k-Wave-python well maintained?

Is k-Wave-python safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues