Data

Tools

Indexes

Applications

Experiments

Open Source Science

citationpep

Sketching out a PEP for a software citation standard

https://github.com/adrn/citationpep

Science Score: 31.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
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 5 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (6.8%) to scientific vocabulary
Last synced: 11 months ago · JSON representation ·

Repository

Sketching out a PEP for a software citation standard

Basic Info
  • Host: GitHub
  • Owner: adrn
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 33.2 KB
Statistics
  • Stars: 6
  • Watchers: 6
  • Forks: 0
  • Open Issues: 4
  • Releases: 0
Created over 8 years ago · Last pushed about 6 years ago
Metadata Files
Readme License Citation

README.md

CitationPEP

Proposing a new guideline for defining software citations, and a new builtin function for retrieving citations.

Packages can implement whatever they want in __citation__: This can be a DOI, bibtex entry, list of bibtex entries, or custom object.

For example:

```python

import astropy astropy.citation https://doi.org/10.1051/0004-6361/201322068 citation(astropy) https://doi.org/10.1051/0004-6361/201322068 ```

Calling citation() with no argument returns the citations of all imported modules as a dictionary keyed by the package name: ```python

import astroML citations = citation() print(citations['astroML']) @INPROCEEDINGS{astroML, author={{Vanderplas}, J.T. and {Connolly}, A.J. and {Ivezi{'c}}, { Z}. and {Gray}, A.}, booktitle={Conference on Intelligent Data Understanding (CIDU)}, title={Introduction to astroML: Machine learning for astrophysics}, month={Oct.}, pages={47 -54}, doi={10.1109/CIDU.2012.6382200}, year={2012} } print(citations['citationpep']) # included as an example This is a demo citation! See https://github.com/adrn/CitationPEP/blob/master/citationpep/init.py ```

See the NOTES for more information.

Authors

Owner

  • Name: Adrian Price-Whelan
  • Login: adrn
  • Kind: user
  • Location: NYC
  • Company: Flatiron Institute

Citation (citationpep/__init__.py) 

from .core import *

__citation__ = 'This is a demo citation! See ' \
    + 'https://github.com/adrn/CitationPEP/blob/master/citationpep/__init__.py'

GitHub Events

Total
Last Year

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 27
  • Total Committers: 1
  • Avg Commits per committer: 27.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Adrian Price-Whelan a****w@g****m 27

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 4
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 4
  • Total pull request authors: 0
  • Average comments per issue: 0.5
  • 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
View more stats
Top Authors
Issue Authors
  • ashwinvis (1)
  • kelle (1)
  • adrn (1)
  • jameshowison (1)
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels