fair-python-cookiecutter-demo
Live demo to demonstrate a repository created from the fair-python-cookiecutter template.
https://github.com/materials-data-science-and-informatics/fair-python-cookiecutter-demo
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 (14.7%) to scientific vocabulary
Keywords
Repository
Live demo to demonstrate a repository created from the fair-python-cookiecutter template.
Basic Info
- Host: GitHub
- Owner: Materials-Data-Science-and-Informatics
- License: unlicense
- Language: Python
- Default Branch: main
- Homepage: https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter
- Size: 2.72 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
fair-python-cookiecutter-demo
:warning: TODO: Complete project setup :construction:
This is a Python project generated from the fair-python-cookiecutter template.
TODO: To finalize the project setup, please carefully read and follow the instructions in the
developer guide.
A copy of the guide is included in your project in docs/dev_guide.md.
TODO - add description
:construction: TODO: Write a paragraph summarizing what this project is about.
Installation
TODO: check that the installation instructions work
This project works with Python > 3.9.
bash
pip install git+ssh://git@github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo.git
Getting Started
TODO: provide a minimal working example
Troubleshooting
When I try installing the package, I get an IndexError: list index out of range
Make sure you have pip > 21.2 (see pip --version), older versions have a bug causing
this problem. If the installed version is older, you can upgrade it with
pip install --upgrade pip and then try again to install the package.
You can find more information on using and contributing to this repository in the documentation.
How to Cite
If you want to cite this project in your scientific work, please use the citation file in the repository.
Acknowledgements
We kindly thank all authors and contributors.
TODO: relevant organizational acknowledgements (employers, funders)
Owner
- Name: Materials Data Science and Informatics
- Login: Materials-Data-Science-and-Informatics
- Kind: organization
- Repositories: 8
- Profile: https://github.com/Materials-Data-Science-and-Informatics
Citation (CITATION.cff)
cff-version: 1.2.0
type: software
message: If you use this software, please cite it using this metadata.
title: "fair-python-cookiecutter-demo"
version: "1.0.0"
abstract: "TODO - add description"
repository-code: "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo"
license: "Unlicense"
keywords:
- TODO
- add
- keywords
authors:
- family-names: Pirogov
given-names: Anton
email: a.pirogov@fz-juelich.de
orcid: https://orcid.org/0000-0002-5077-7497
affiliation: Forschungszentrum Jülich GmbH - Institute for Materials Data Science
and Informatics (IAS9)
contact:
- email: a.pirogov@fz-juelich.de
family-names: Pirogov
orcid: https://orcid.org/0000-0002-5077-7497
given-names: Anton
url:
https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo
CodeMeta (codemeta.json)
{
"@context": [
"https://doi.org/10.5063/schema/codemeta-2.0",
"https://w3id.org/software-iodata",
"https://raw.githubusercontent.com/jantman/repostatus.org/master/badges/latest/ontology.jsonld",
"https://schema.org",
"https://w3id.org/software-types"
],
"@type": "SoftwareSourceCode",
"author": [
{
"@type": "Person",
"givenName": "Anton",
"familyName": "Pirogov",
"email": "a.pirogov@fz-juelich.de",
"@id": "https://orcid.org/0000-0002-5077-7497",
"identifier": "https://orcid.org/0000-0002-5077-7497"
}
],
"name": "fair-python-cookiecutter-demo",
"description": "TODO - add description",
"version": "1.0.0",
"keywords": [
"TODO",
"add",
"keywords"
],
"maintainer": [
{
"@type": "Person",
"givenName": "Anton",
"familyName": "Pirogov",
"email": "a.pirogov@fz-juelich.de",
"@id": "https://orcid.org/0000-0002-5077-7497",
"identifier": "https://orcid.org/0000-0002-5077-7497"
}
],
"license": [
"https://spdx.org/licenses/Unlicense"
],
"softwareHelp": "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo",
"codeRepository": "https://github.com/Materials-Data-Science-and-Informatics/fair-python-cookiecutter-demo",
"buildInstructions": "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo",
"url": "https://materials-data-science-and-informatics.github.io/fair-python-cookiecutter-demo"
}GitHub Events
Total
- Push event: 1
- Create event: 1
Last Year
- Push event: 1
- Create event: 1
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0