Data

Tools

Indexes

Applications

Experiments

Open Source Science

nomad-sintering

https://github.com/hampusnasstrom/nomad-sintering

Science Score: 44.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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: hampusnasstrom
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 522 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 12
Created almost 2 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

nomad-sintering

This is a schema package plugin for sintering.

This nomad_ plugin was generated with Cookiecutter_ along with @nomad's cookiecutter-nomad-plugin template.

Install

You should create a virtual environment. You will need the nomad-lab package (and pytest). We recommend using Python 3.9.

sh python3 -m venv .pyenv source .pyenv/bin/activate pip install --upgrade pip pip install -e '.[dev]' --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple

Note! Until we have an official pypi NOMAD release with the plugins functionality. Make sure to include NOMAD's internal package registry (e.g. via --index-url).

Testing

You can run automated tests with pytest:

sh pytest -svx tests

Run linting

sh ruff check .

Run auto-formatting

This is entirely optional. To add this as a check in github actions pipeline, uncomment the ruff-formatting step in ./github/workflows/actions.yaml.

sh ruff format .

Developing a NOMAD plugin

Follow the guide on how to develop NOMAD plugins.

Build the python package

The pyproject.toml file contains everything that is necessary to turn the project into a pip installable python package. Run the python build tool to create a package distribution:

pip install build python -m build --sdist

You can install the package with pip:

pip install dist/nomad-sintering-0.1.0

Read more about python packages, pyproject.toml, and how to upload packages to PyPI on the PyPI documentation.

Documentation on Github pages

To deploy documentation on Github pages, make sure to enable GitHub pages via the repo settings.

To view the documentation locally, install the documentation related packages using:

sh pip install -r requirements_docs.txt

Run the documentation server: sh mkdocs serve

Template update

We use cruft to update the project based on template changes. A cruft-update.yml is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the instructions on how to enable Github Actions to create pull requests.

To run the check for updates locally, follow the instructions on cruft website.

License

Distributed under the terms of the MIT_ license, "nomad-sintering" is free and open source software

Owner

  • Name: Hampus Näsström
  • Login: hampusnasstrom
  • Kind: user

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- given-names: "Hampus"
  family-names: "Näsström"
  orcid: "https://orcid.org/0000-0002-3264-1692"
title: "nomad-sintering"
version: 1.0.5
doi: 10.5072/zenodo.110426
date-released: 2024-09-18
url: "https://github.com/hampusnasstrom/nomad-sintering"

GitHub Events

Total
  • Create event: 58
  • Release event: 5
  • Issues event: 1
  • Delete event: 161
  • Push event: 9
  • Pull request event: 200
Last Year
  • Create event: 58
  • Release event: 5
  • Issues event: 1
  • Delete event: 161
  • Push event: 9
  • Pull request event: 200

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • github-actions[bot] (4)
  • hampusnasstrom (1)
Pull Request Authors
  • github-actions[bot] (142)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/actions.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • chartboost/ruff-action v1 composite
.github/workflows/cruft-update.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • peter-evans/create-pull-request v4 composite
.github/workflows/mkdocs-deploy.yml actions
  • actions/checkout v4 composite
  • mhausenblas/mkdocs-deploy-gh-pages master composite
pyproject.toml pypi
  • nomad-lab >=1.2.2dev578
requirements_docs.txt pypi
  • mkdocs *
  • mkdocs-click *
  • mkdocs-material ==8.1.1
  • pymdown-extensions *