nomad-material-processing

v1.0.4

A plugin for NOMAD containing base sections for material processing. For more information about how to use this package see README

Latest version published 2 months ago

License: Apache-2.0

PyPI

GitHub

Package Health Score

69 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Limited

Popularity

Limited

GitHub Stars: 9
Forks: 2
Contributors: 8

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package nomad-material-processing, we found that it has been starred 9 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Sep 19, 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

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like nomad-material-processing 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

Healthy

Commit Frequency

Open Issues: 16
Open PR: 4
Last Release: 2 months ago
Last Commit: 1 month ago

Further analysis of the maintenance status of nomad-material-processing based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that nomad-material-processing demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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

Limited

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like nomad-material-processing 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.10.*, ==3.11.*, ==3.12.*, ==3.9.*

Age: 1 year
Latest Release: 2 months ago
Dependencies: 0 Direct
Versions: 15
Maintainers: 4
Wheels: OS Independent

Readme

NOMAD's Material Processing Plugin

This is a plugin for NOMAD which contains base sections for material processing.

Getting started

nomad-material-processing can be installed from PyPI using pip.

[!WARNING] Unfortunately, the current plugin mechanism is not supported by the latest nomad-lab version on PyPI and therefore an index url pointing to the NOMAD Gitlab registry needs to be added.

pip install nomad-material-processing --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple

Setting up your OASIS

Read the NOMAD plugin documentation for all details on how to deploy the plugin on your NOMAD instance.

You don't need to modify the nomad.yaml configuration file of your NOMAD instance, beacuse the package is pip installed and all the available modules (entry points) are loaded. To include, instead, only some of the entry points, you need to specify them in the include section of the nomad.yaml. In the following lines, a list of all the available entry points:

plugins:
  include:
    - "nomad_material_processing:schema"
    - "nomad_material_processing.solution:schema"
    - "nomad_material_processing.vapor_deposition.cvd:schema"
    - "nomad_material_processing.vapor_deposition.pvd:schema"
    - "nomad_material_processing.vapor_deposition.pvd:mbe_schema"
    - "nomad_material_processing.vapor_deposition.pvd:pld_schema"
    - "nomad_material_processing.vapor_deposition.pvd:sputtering_schema"
    - "nomad_material_processing.vapor_deposition.pvd:thermal_schema"

Development

This code is currently under development and for installing and contributing you should clone the repository:

git clone git@github.com:FAIRmat-NFDI/nomad-material-processing.git
cd nomad-material-processing

And install the package in editable mode:

pip install -e .[dev] --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple

FAQs

What is nomad-material-processing?

A plugin for NOMAD containing base sections for material processing. Visit Snyk Advisor to see a full health score report for nomad-material-processing, including popularity, security, maintenance & community analysis.

Is nomad-material-processing popular?

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

Is nomad-material-processing well maintained?

We found that nomad-material-processing demonstrated a healthy version release cadence and project activity. It has a community of 8 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is nomad-material-processing safe to use?

The python package nomad-material-processing 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 19 November-2024, at 05:31 (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