Package Health Score

47 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Limited

GitHub Stars: 25
Forks: 21
Contributors: 20

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package pyschism, we found that it has been starred 25 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Nov 7, 2023
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 2
H
7
M
0
L

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

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like pyschism 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: 36
Open PR: 2
Last Release: 1 year ago
Last Commit: 1 month ago

Further analysis of the maintenance status of pyschism 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 pyschism 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.

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

Sustainable

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

With more than 10 contributors for the pyschism 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 pyschism 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.6

Age: 4 years
Latest Release: 1 year ago
Dependencies: 29 Direct / 85 Total
Versions: 24
Maintainers: 1
Wheels: OS Independent

Readme

PySCHISM

A Python interface for SCHISM model runs.

Installation:

Pre-requisites

It is highly recommended that you run this software using a Python virtual environment, and that you use Python>=3.6 (preferrably, using the latest available Python version is encouraged). You may use conda or venv to satisfy this dependency. You should also have the cdunits library installed. In ubuntu systems this is achieved by:

apt-get install udunits-bin

Install option 1: pip

pip install pyschism

Install option 2: clone repo

To install, clone this repository, and navigate into it:

git clone https://github.com/schism-dev/pyschism
cd pyschism

Then make sure to activate the target Python environment (this step is not necessary if you chose not to use a virtual environment). After making sure your target environment is active, you can install the package using pip:

pip install .

If you are a developer

If you are a developer, it is recommended that you clone the repo. After you add the -e flag to the pip install command in order to install in developer mode.

pip install -e .

Usage examples:

Using the Library

Example 1: Full domain Hgrid plot:

from pyschism.mesh import Hgrid
hgrid = Hgrid.open('hgrid.gr3')
hgrid.make_plot(show=True)

Example 2: Write mesh to QGIS friendly format

# NOTE: 2dm files can be read by QGIS > 3.0
from pyschism.mesh import Hgrid
hgrid = Hgrid.open('hgrid.gr3')
hgrid.write("/path/to/output/file.2dm", fmt='2dm')

Online manual

https://schism-dev.github.io/schism/master/getting-started/pre-processing-with-pyschism/overview.html

References

If you used this software as part of your work, please use the following citation format.

Jaime R Calzada, Linlin Cui, & Joseph Zhang. (2023). schism-dev/pyschism: v0.1.5 (v0.1.5). Zenodo. https://doi.org/10.5281/zenodo.7623122

Questions, comments and suggestions are welcome. Please follow the instructions on the CONTRIBUTING.md file for contributions. For bug reports and feature requests, please open an issue using the issue tracker. Main author name: Jaime R Calzada Author contact: jrcalzada@vims.edu

“Marconi is a good fellow. Let him continue. He is using seventeen of my patents.”
Nikola Tesla

FAQs

What is pyschism?

Python package for working with SCHISM input and output files. Visit Snyk Advisor to see a full health score report for pyschism, including popularity, security, maintenance & community analysis.

Is pyschism popular?

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

Is pyschism well maintained?

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

Is pyschism safe to use?

While scanning the latest version of pyschism, 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 28 November-2024, at 14:42 (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