{"id":"https://openalex.org/W4392020262","doi":"https://doi.org/10.5281/zenodo.10426363","title":"Best practices for documenting a scientific Python project","display_name":"Best practices for documenting a scientific Python project","alternate_titles":[],"publication_year":2023,"publication_date":"2023-12-22","ids":{"openalex":"https://openalex.org/W4392020262","doi":"https://doi.org/10.5281/zenodo.10426363"},"language":"en","primary_location":{"id":"pmh:oai:osti.gov:2305819","doi":null,"is_oa":true,"landing_page_url":"https://www.osti.gov/biblio/2305819","pdf_url":"https://www.osti.gov/servlets/purl/2305819","source":{"id":"https://openalex.org/S4306402487","display_name":"OSTI OAI (U.S. Department of Energy Office of Scientific and Technical Information)","issn_l":null,"issn":null,"is_oa":false,"is_in_doaj":false,"is_core":false,"listed_in":[],"host_organization":"https://openalex.org/I139351228","host_organization_name":"Office of Scientific and Technical Information","host_organization_lineage":["https://openalex.org/I139351228"],"host_organization_lineage_names":[],"type":"repository"},"license":null,"license_id":null,"version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":null},"parent_works":[],"lineage":["https://openalex.org/W4392020262"],"child_works_count":0,"type":"article","is_traditional":true,"indexed_in":["datacite"],"open_access":{"is_oa":true,"oa_status":"green","oa_url":"https://www.osti.gov/servlets/purl/2305819","any_repository_has_fulltext":true},"authorships":[{"author_position":"first","author":{"id":"https://openalex.org/A5005206222","display_name":"Gavin M. Wiggins","orcid":"https://orcid.org/0000-0002-4737-6596","observed_orcids":["https://orcid.org/0000-0002-4737-6596"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Wiggins, Gavin","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":"https://orcid.org/0000-0002-4737-6596","affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5053043349","display_name":"Gregory Cage","orcid":"https://orcid.org/0009-0001-8038-9102","observed_orcids":["https://orcid.org/0009-0001-8038-9102"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Cage, Gregory","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5107274901","display_name":"Robert C. Smith","orcid":"https://orcid.org/0000-0002-6058-1025","observed_orcids":["https://orcid.org/0000-0002-6058-1025"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Smith, Robert","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5057766278","display_name":"Seth D. Hitefield","orcid":null,"observed_orcids":[]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Hitefield, Seth","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5071017827","display_name":"Marshall T. McDonnell","orcid":"https://orcid.org/0000-0002-3713-2117","observed_orcids":["https://orcid.org/0000-0002-3713-2117"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"McDonnell, Marshall","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":"https://orcid.org/0000-0002-3713-2117","affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5066217571","display_name":"Lance Drane","orcid":"https://orcid.org/0000-0001-8808-1228","observed_orcids":["https://orcid.org/0000-0001-8808-1228"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Drane, Lance","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5072941919","display_name":"Jesse McGaha","orcid":"https://orcid.org/0000-0001-9469-8451","observed_orcids":["https://orcid.org/0000-0001-9469-8451"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"McGaha, Jesse","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5058645311","display_name":"Michael J. Brim","orcid":"https://orcid.org/0000-0002-7479-5526","observed_orcids":["https://orcid.org/0000-0002-7479-5526"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Brim, Michael","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5052129734","display_name":"M Abraham","orcid":"https://orcid.org/0000-0001-6363-2521","observed_orcids":["https://orcid.org/0000-0001-6363-2521"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Abraham, Mark","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5043192992","display_name":"Richard K. Archibald","orcid":"https://orcid.org/0000-0002-4538-9780","observed_orcids":["https://orcid.org/0000-0002-4538-9780"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Archibald, Richard","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]},{"author_position":"last","author":{"id":"https://openalex.org/A5055368248","display_name":"Addi Malviya Thakur","orcid":"https://orcid.org/0000-0002-2681-9992","observed_orcids":["https://orcid.org/0000-0002-2681-9992"]},"institutions":[{"id":"https://openalex.org/I1289243028","display_name":"Oak Ridge National Laboratory","ror":"https://ror.org/01qz5mb56","country_code":"US","type":"facility","lineage":["https://openalex.org/I1289243028","https://openalex.org/I1330989302","https://openalex.org/I39565521","https://openalex.org/I4210159294"]}],"countries":["US"],"is_corresponding":false,"contributor_roles":[],"raw_author_name":"Malviya-Thakur, Addi","raw_affiliation_strings":["Oak Ridge National Laboratory","ORNL"],"raw_orcid":null,"affiliations":[{"raw_affiliation_string":"Oak Ridge National Laboratory","institution_ids":["https://openalex.org/I1289243028"]},{"raw_affiliation_string":"ORNL","institution_ids":["https://openalex.org/I1289243028"]}]}],"institutions":[],"countries_distinct_count":1,"institutions_distinct_count":1,"corresponding_author_ids":[],"corresponding_institution_ids":["https://openalex.org/I1289243028"],"apc_list":null,"apc_paid":null,"fwci":0.8553,"has_fulltext":true,"cited_by_count":6,"citation_normalized_percentile":{"value":0.74363144,"is_in_top_1_percent":false,"is_in_top_10_percent":false},"cited_by_percentile_year":{"min":94,"max":97},"biblio":{"volume":null,"issue":null,"first_page":null,"last_page":null},"is_retracted":false,"is_pulled":false,"is_paratext":false,"is_xpac":false,"primary_topic":{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.35030001401901245,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},"topics":[{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.35030001401901245,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T10430","display_name":"Software Engineering Techniques and Practices","score":0.30660000443458557,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T11986","display_name":"Scientific Computing and Data Management","score":0.2476000040769577,"subfield":{"id":"https://openalex.org/subfields/1802","display_name":"Information Systems and Management"},"field":{"id":"https://openalex.org/fields/18","display_name":"Decision Sciences"},"domain":{"id":"https://openalex.org/domains/2","display_name":"Social Sciences"}}],"keywords":[{"id":"https://openalex.org/keywords/software-documentation","display_name":"software documentation","score":0.8479999899864197},{"id":"https://openalex.org/keywords/python-projects","display_name":"Python projects","score":0.5759999752044678},{"id":"https://openalex.org/keywords/sphinx","display_name":"sphinx","score":0.9570000171661377},{"id":"https://openalex.org/keywords/docstrings","display_name":"docstrings","score":0.9070000052452087},{"id":"https://openalex.org/keywords/api-documentation","display_name":"API documentation","score":0.9020000100135803},{"id":"https://openalex.org/keywords/docker-containers","display_name":"Docker containers","score":0.925000011920929},{"id":"https://openalex.org/keywords/nginx","display_name":"Nginx","score":0.9399999976158142},{"id":"https://openalex.org/keywords/autonomous-laboratories","display_name":"autonomous laboratories","score":0.8270000219345093},{"id":"https://openalex.org/keywords/open-source-software","display_name":"open source software","score":0.5440000295639038},{"id":"https://openalex.org/keywords/developer-onboarding","display_name":"developer onboarding","score":0.6259999871253967}],"concepts":[{"id":"https://openalex.org/C519991488","wikidata":"https://www.wikidata.org/wiki/Q28865","display_name":"Python (programming language)","level":2,"score":0.7940347194671631},{"id":"https://openalex.org/C41008148","wikidata":"https://www.wikidata.org/wiki/Q21198","display_name":"Computer science","level":0,"score":0.6813591718673706},{"id":"https://openalex.org/C199360897","wikidata":"https://www.wikidata.org/wiki/Q9143","display_name":"Programming language","level":1,"score":0.47823041677474976},{"id":"https://openalex.org/C115903868","wikidata":"https://www.wikidata.org/wiki/Q80993","display_name":"Software engineering","level":1,"score":0.37191733717918396}],"mesh":[],"locations_count":3,"locations":[{"id":"pmh:oai:osti.gov:2305819","doi":null,"is_oa":true,"landing_page_url":"https://www.osti.gov/biblio/2305819","pdf_url":"https://www.osti.gov/servlets/purl/2305819","source":{"id":"https://openalex.org/S4306402487","display_name":"OSTI OAI (U.S. Department of Energy Office of Scientific and Technical Information)","issn_l":null,"issn":null,"is_oa":false,"is_in_doaj":false,"is_core":false,"listed_in":[],"host_organization":"https://openalex.org/I139351228","host_organization_name":"Office of Scientific and Technical Information","host_organization_lineage":["https://openalex.org/I139351228"],"host_organization_lineage_names":[],"type":"repository"},"license":null,"license_id":null,"version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":null},{"id":"doi:10.5281/zenodo.10426363","doi":"https://doi.org/10.5281/zenodo.10426363","is_oa":true,"landing_page_url":"https://doi.org/10.5281/zenodo.10426363","pdf_url":null,"source":{"id":"https://openalex.org/S4306400562","display_name":"Zenodo (CERN European Organization for Nuclear Research)","issn_l":null,"issn":null,"is_oa":true,"is_in_doaj":false,"is_core":false,"listed_in":[],"host_organization":"https://openalex.org/I67311998","host_organization_name":"European Organization for Nuclear Research","host_organization_lineage":["https://openalex.org/I67311998"],"host_organization_lineage_names":[],"type":"repository"},"license":"cc-by","license_id":"https://openalex.org/licenses/cc-by","version":null,"is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":"ConferencePaper"},{"id":"doi:10.5281/zenodo.10426364","doi":"https://doi.org/10.5281/zenodo.10426364","is_oa":true,"landing_page_url":"https://doi.org/10.5281/zenodo.10426364","pdf_url":null,"source":{"id":"https://openalex.org/S4306400562","display_name":"Zenodo (CERN European Organization for Nuclear Research)","issn_l":null,"issn":null,"is_oa":true,"is_in_doaj":false,"is_core":false,"listed_in":[],"host_organization":"https://openalex.org/I67311998","host_organization_name":"European Organization for Nuclear Research","host_organization_lineage":["https://openalex.org/I67311998"],"host_organization_lineage_names":[],"type":"repository"},"license":"cc-by","license_id":"https://openalex.org/licenses/cc-by","version":null,"is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":"ConferencePaper"}],"best_oa_location":{"id":"pmh:oai:osti.gov:2305819","doi":null,"is_oa":true,"landing_page_url":"https://www.osti.gov/biblio/2305819","pdf_url":"https://www.osti.gov/servlets/purl/2305819","source":{"id":"https://openalex.org/S4306402487","display_name":"OSTI OAI (U.S. Department of Energy Office of Scientific and Technical Information)","issn_l":null,"issn":null,"is_oa":false,"is_in_doaj":false,"is_core":false,"listed_in":[],"host_organization":"https://openalex.org/I139351228","host_organization_name":"Office of Scientific and Technical Information","host_organization_lineage":["https://openalex.org/I139351228"],"host_organization_lineage_names":[],"type":"repository"},"license":null,"license_id":null,"version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":null},"sustainable_development_goals":[{"id":"https://metadata.un.org/sdg/9","score":0.4943999946117401,"display_name":"Industry, innovation and infrastructure"}],"study_designs":[],"awards":[],"funders":[],"has_content":{"pdf":true,"grobid_xml":true},"content_urls":{"pdf":"https://content.openalex.org/works/W4392020262.pdf","grobid_xml":"https://content.openalex.org/works/W4392020262.grobid-xml"},"referenced_works_count":3,"referenced_works":["https://openalex.org/W2296335794","https://openalex.org/W2507622755","https://openalex.org/W4316923794"],"related_works":["https://openalex.org/W4291232929","https://openalex.org/W6912512587","https://openalex.org/W3208066777","https://openalex.org/W7169296742","https://openalex.org/W7150794540","https://openalex.org/W2596564030","https://openalex.org/W4411104096","https://openalex.org/W4401946703","https://openalex.org/W2901453519","https://openalex.org/W6893451876"],"abstract_inverted_index":{"Documentation":[0,18],"is":[1,52,121],"a":[2,25,147],"crucial":[3],"component":[4],"of":[5,15,62],"software":[6,26],"development":[7,61],"that":[8],"helps":[9,20],"users":[10,83],"with":[11,28,133],"installation":[12],"and":[13,31,43,81,103,114,124,154],"usage":[14],"the":[16,35,60,78,85,152],"software.":[17],"also":[19],"onboard":[21],"new":[22],"developers":[23,75],"to":[24,58,73,77,100,129,142],"project":[27,51,149],"contributing":[29],"guidelines":[30],"API":[32,112],"information.":[33],"Without":[34],"right":[36],"tools,":[37],"generating":[38],"documentation":[39,66,113,119,145],"can":[40,107,150],"be":[41,108],"laborious":[42],"distract":[44],"from":[45],"code":[46,80],"development.":[47],"The":[48,117,136],"INTERSECT":[49,86],"SDK":[50,87],"an":[53],"open":[54],"federated":[55],"hardware/software":[56],"library":[57],"facilitate":[59],"autonomous":[63],"laboratories.":[64],"A":[65],"strategy":[67],"using":[68,126],"Sphinx":[69,99],"has":[70],"been":[71],"utilized":[72],"help":[74,82],"contribute":[76],"source":[79],"understand":[84],"Python":[88,148],"interface.":[89],"Docstrings":[90],"as":[91,93,111],"well":[92],"reStructuredText":[94],"files":[95],"are":[96],"used":[97],"by":[98],"generate":[101],"HTML":[102],"PDF":[104],"files,":[105],"which":[106],"hosted":[109],"online":[110],"user":[115,153],"guides.":[116],"resulting":[118],"website":[120],"automatically":[122,143],"built":[123],"deployed":[125],"GitLab":[127],"runners":[128],"create":[130],"Docker":[131],"containers":[132],"NGINX":[134],"servers.":[135],"approach":[137],"discussed":[138],"in":[139],"this":[140],"paper":[141],"deploy":[144],"for":[146,157],"improve":[151],"developer":[155],"experience":[156],"many":[158],"scientific":[159],"projects.":[160]},"cited_by_api_url":"https://api.openalex.org/works?filter=cites:W4392020262","counts_by_year":[{"year":2026,"cited_by_count":2},{"year":2025,"cited_by_count":4}],"updated_date":"2026-11-16T12:05:36.265796","created_date":"2024-02-22T00:00:00"}
