pfhub-cli

PFHub CLI tool

https://github.com/usnistgov/pfhub-cli

Science Score: 65.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
Found 2 DOI reference(s) in README
○
Academic publication links
○
Academic email domains
✓
Institutional organization owner
Organization usnistgov has institutional domain (www.nist.gov)
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (11.9%) to scientific vocabulary

Keywords

materials-science phase-field phase-field-method

Last synced: 6 months ago · JSON representation ·

Repository

PFHub CLI tool

Basic Info

Host: GitHub
Owner: usnistgov
License: other
Language: Jupyter Notebook
Default Branch: main
Homepage: https://pages.nist.gov/pfhub-cli
Size: 31.9 MB

Statistics

Stars: 0
Watchers: 3
Forks: 4
Open Issues: 6
Releases: 0

Topics

materials-science phase-field phase-field-method

Created over 2 years ago · Last pushed almost 2 years ago

Metadata Files

Readme License Citation

README.md

PFHub CLI

Overview

A Python module for both rendering and submitting PFHub phase-field benchmark results using Jupyter, Pandas and Plotly.

To view benchmark results go to the live website at pages.nist.gov/pfhub.

Installation

Using Pip

First install a Python environment manager such as Micromamba and ensure Pip is available. To install the PFHub CLI use,

$ pip install git+https://github.com/usnistgov/pfhub-cli.git

Using Nix

First install the Nix package manager and then enable Flakes. To install the PFHub CLI use,

$ nix shell github:usnistgov/pfhub-cli

for just the command line tool or

$ nix develop github:usnistgov/pfhub-cli

to generate an environment with Python and Jupyter available. See the Nix section of the development guide to get more help starting out with Nix.

Usage

Test

To test that the PFHub CLI is installed correctly use

$ pfhub test

A single test will fail if ZENODO_SANDBOX_API_TOKEN is not set, see the development guide.

Submit a benchmark result

Under construction.

Contributions

Contributions are welcome. See the development guide to get started.

License

See the NIST license

Cite

If you need to cite the PFHub CLI, please see CITATION.cff and cite it as follows:

Wheeler, D., Keller, T., DeWitt, S. J., Jokisaari, A. M., Schwen, D., Guyer, J. E., Aagesen, L. K., Heinonen, O. G., Tonks, M. R., Voorhees, P. W., Warren, J. A. (2019). PFHub: The Phase-Field Community Hub. Journal of Open Research Software, 7(1), 29. DOI: http://doi.org/10.5334/jors.276

Owner

Name: National Institute of Standards and Technology
Login: usnistgov
Kind: organization
Location: Gaithersburg, Md.

Website: https://www.nist.gov
Repositories: 1,117
Profile: https://github.com/usnistgov

Department of Commerce

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
 - family-names: "Wheeler"
   given-names: "Daniel"
   orcid: https://orcid.org/0000-0002-2653-7418
 - family-names: "Keller"
   given-names: "Trevor"
   orcid: https://orcid.org/0000-0002-2920-8302
 - family-names: "DeWitt"
   given-names: "Stephen J."
   orcid: https://orcid.org/0000-0002-9550-293X
 - family-names: "Jokisaari"
   given-names: "Andrea M."
   orcid: https://orcid.org/0000-0002-4945-5714
 - family-names: "Schwen"
   given-names: "Daniel"
   orcid: https://orcid.org/0000-0002-8958-4748
 - family-names: "Guyer"
   given-names: "Jonathon E."
   orcid: https://orcid.org/0000-0002-1407-6589
 - family-names: "Aagesen"
   given-names: "Larry K."
   orcid: https://orcid.org/0000-0003-4936-676X
 - family-names: "Heinonen"
   given-names: "Olle G."
   orcid: https://orcid.org/0000-0002-3618-6092
 - family-names: "Tonks"
   given-names: "Michael R."
   orcid: https://orcid.org/0000-0002-1343-3193
 - family-names: "Voorhees"
   given-names: "Peter W."
   orcid: https://orcid.org/0000-0003-2769-392X
 - family-names: "Warren"
   given-names: "James A."
   orcid: https://orcid.org/0000-0001-6887-1206
title: "PFHub: Phase Community Hub"
version: 0.1
doi: 10.5281/zenodo.2592705
date-released: 2019-03-13
url: https://github.com/usnistgov/pfhub
preferred-citation:
  type: article
  authors:
   - family-names: "Wheeler"
     given-names: "Daniel"
     orcid: https://orcid.org/0000-0002-2653-7418
   - family-names: "Keller"
     given-names: "Trevor"
     orcid: https://orcid.org/0000-0002-2920-8302
   - family-names: "DeWitt"
     given-names: "Stephen J."
     orcid: https://orcid.org/0000-0002-9550-293X
   - family-names: "Jokisaari"
     given-names: "Andrea M."
     orcid: https://orcid.org/0000-0002-4945-5714
   - family-names: "Schwen"
     given-names: "Daniel"
     orcid: https://orcid.org/0000-0002-8958-4748
   - family-names: "Guyer"
     given-names: "Jonathon E."
     orcid: https://orcid.org/0000-0002-1407-6589
   - family-names: "Aagesen"
     given-names: "Larry K."
     orcid: https://orcid.org/0000-0003-4936-676X
   - family-names: "Heinonen"
     given-names: "Olle G."
     orcid: https://orcid.org/0000-0002-3618-6092
   - family-names: "Tonks"
     given-names: "Michael R."
     orcid: https://orcid.org/0000-0002-1343-3193
   - family-names: "Voorhees"
     given-names: "Peter W."
     orcid: https://orcid.org/0000-0003-2769-392X
   - family-names: "Warren"
     given-names: "James A."
     orcid: https://orcid.org/0000-0001-6887-1206
  doi: 10.5334/jors.276
  journal: "Journal of Open Research Software"
  volume: 7
  issue: 1
  start: 29
  title: "PFHub: Phase Community Hub"
  year: 2019

GitHub Events

Total

Fork event: 2

Last Year

Fork event: 2

Dependencies

.github/workflows/flake-check.yml actions

DeterminateSystems/flake-checker-action v5 composite
DeterminateSystems/nix-installer-action v4 composite
actions/checkout v3 composite

.github/workflows/conda.yml actions

actions/checkout v3 composite
mamba-org/setup-micromamba v1 composite

.github/workflows/nix.yml actions

actions/cache/restore v3 composite
actions/cache/save v3 composite
actions/checkout v3 composite
cachix/install-nix-action v20 composite

poetry.lock pypi

183 dependencies

pyproject.toml pypi

black ^23.11.0
chevron ^0.14.0
click ^8.1.7
click-params ^0.4.1
dotwiz 0.2.0
flake8 ^6.1.0
flake8-pyproject ^1.2.3
ipykernel ^6.27.1
itables ^1.6.2
jinja2 ^3.1.2
linkml ^1.6.2
nbval ^0.10.0
notebook ^7.0.6
numpy ^1.26.1
pandas ^2.1.2
plotly ^5.18.0
pydantic 1.10.13
pykwalify ^1.8.0
pylint ^3.0.2
pytest ^7.4.3
pytest-cov ^4.1.0
python >=3.10,<3.13
pyyaml ^6.0.1
requests ^2.31.0
requests-cache ^1.1.0
requests-mock ^1.11.0
ruamel-yaml 0.17.21
scipy ^1.11.3
toolz ^0.12.0
versioneer ^0.29

.github/workflows/docs.yml actions

actions/cache/restore v3 composite
actions/cache/save v3 composite
actions/checkout v3 composite
cachix/install-nix-action v20 composite

.github/workflows/pip.yml actions

mamba-org/setup-micromamba v1 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science