Software Citation andOther Incentives

NIH BD2K Software Discovery Workshop May 12-13 2014 Washington DC

Martin Hammitzsch Helmholtz Centre Potsdam GFZ German Research Centre for Geosciences

software engineer with empty publication list

independent contributions poorly perceived amp hardly measurable not assessed amp not valued

lack of common understanding amp defined processes

direct release not possible as scientific publication

workaround publications in desired journals

Image httpkatherineprestoncomowning-your-own-story

The paper must be accompanied by the code or means of

accessing the code for the purpose of peer-review If the code

is normally distributed in a way which could compromise the

anonymity of the referees then the code must be made available

to the editor The refereeeditor is not required to review the

code in any way but they may do so if they so wish

All papers must include a section at the end of the paper

entitled ldquoCode availabilityrdquo In this section instructions for

obtaining the code (eg from a supplement or from a website)

should be included alternatively contact information should be

given where the code can be obtained on request or the reasons

why the code is not available should be clearly stated

We strongly encourage authors to upload any user manuals

associated with the code

For models where this is practicable we strongly encourage

referees to compile the code and run test cases supplied by the

authors where appropriate

Unlike internal reports GMD papers undergo a peer-review

process which establishes the criteria for full publication of

model developments Submitted code has not itself been peer-

reviewed by GMD but as one of our new initiatives we will

require that referees and editors obtain the model code and

encourage them to execute test cases where practical

example 1

example 2

example 3

example 4

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

software engineer with empty publication list

independent contributions poorly perceived amp hardly measurable not assessed amp not valued

lack of common understanding amp defined processes

direct release not possible as scientific publication

workaround publications in desired journals

Image httpkatherineprestoncomowning-your-own-story

The paper must be accompanied by the code or means of

accessing the code for the purpose of peer-review If the code

is normally distributed in a way which could compromise the

anonymity of the referees then the code must be made available

to the editor The refereeeditor is not required to review the

code in any way but they may do so if they so wish

All papers must include a section at the end of the paper

entitled ldquoCode availabilityrdquo In this section instructions for

obtaining the code (eg from a supplement or from a website)

should be included alternatively contact information should be

given where the code can be obtained on request or the reasons

why the code is not available should be clearly stated

We strongly encourage authors to upload any user manuals

associated with the code

For models where this is practicable we strongly encourage

referees to compile the code and run test cases supplied by the

authors where appropriate

Unlike internal reports GMD papers undergo a peer-review

process which establishes the criteria for full publication of

model developments Submitted code has not itself been peer-

reviewed by GMD but as one of our new initiatives we will

require that referees and editors obtain the model code and

encourage them to execute test cases where practical

example 1

example 2

example 3

example 4

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

The paper must be accompanied by the code or means of

accessing the code for the purpose of peer-review If the code

is normally distributed in a way which could compromise the

anonymity of the referees then the code must be made available

to the editor The refereeeditor is not required to review the

code in any way but they may do so if they so wish

All papers must include a section at the end of the paper

entitled ldquoCode availabilityrdquo In this section instructions for

obtaining the code (eg from a supplement or from a website)

should be included alternatively contact information should be

given where the code can be obtained on request or the reasons

why the code is not available should be clearly stated

We strongly encourage authors to upload any user manuals

associated with the code

For models where this is practicable we strongly encourage

referees to compile the code and run test cases supplied by the

authors where appropriate

Unlike internal reports GMD papers undergo a peer-review

process which establishes the criteria for full publication of

model developments Submitted code has not itself been peer-

reviewed by GMD but as one of our new initiatives we will

require that referees and editors obtain the model code and

encourage them to execute test cases where practical

example 1

example 2

example 3

example 4

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

example 2

example 3

example 4

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

example 3

example 4

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

example 4

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

example 5

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

example 6

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

citation

identifier

asset

landing spot accessible amp persistent web page with related content

documentation what it is what it does amp what it is used for

binary test amp example data guide how to use

code compile how-to got-stuck FAQ dependency information third party releases

code design amp architecture dev-envhow-to API reference automated tests amp builds

authors contacts responsibilities ORCID references

identifier snippets how to cite metadata

integrated or hyperlinks

license

software bundle package release

Itrsquos not just making code citable hellip

nor citing self-contained code

Image httpsboxfreshcomauproductsfruit-veg

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

Image httptepperjacksontravelcollectioncomfun_luggage_tagscool_id_tags

Citability and DOI are no quality criteriavisibility credit balance incentive

badges reviews discussions ratings citation counts metrics based evaluations

social aspect commitment persistence maintenance

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

community of practice

Publish Acknowledge Cite Get credituse existing but imperfect mechanisms gain experience get used to it while using it

driving factor

common understanding

defined accepted amp adopted processes

joint incentives amp platform

approaches no singlesolution no one size fits all

Image httpwwwartofblogcomwp-contentuploads201207Lego_Peoplejpeg

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana

being able to cite means

important work is done

Image httpwwwkirsty-yoga-marbellacomyoga-blogthe-most-difficult-yoga-pose-relaxation-posesavasana