Difference between revisions of "Software Projects"
From SCECpedia
Jump to navigationJump to search| Line 5: | Line 5: | ||
* https://docs.python-guide.org/writing/structure/ | * https://docs.python-guide.org/writing/structure/ | ||
* http://nsls-ii.github.io/scientific-python-cookiecutter/philosophy.html | * http://nsls-ii.github.io/scientific-python-cookiecutter/philosophy.html | ||
| − | |||
== Developing Effective Python Documentation == | == Developing Effective Python Documentation == | ||
| + | * https://journals.plos.org/ploscompbiol/article?id=10.1371%2Fjournal.pcbi.1006561 | ||
* https://realpython.com/documenting-python-code/ | * https://realpython.com/documenting-python-code/ | ||
* https://divio.com/blog/documentation | * https://divio.com/blog/documentation | ||
Revision as of 22:00, 6 April 2020
Collection of links related to creating software distributions
Contents
- 1 Packaging Python Projects
- 2 Developing Effective Python Documentation
- 3 Open Source Software Practices
- 4 Open Source Software Licenses
- 5 USGS Software and Data Acceptance Criteria
- 6 Software Ecosystem
- 7 Developing a Community
- 8 Defining Interfaces
- 9 Data Management Systems
- 10 Continuous Testing Links
- 11 Software Release Practices
- 12 Example Projects
- 13 Related Entries
Packaging Python Projects
- https://packaging.python.org/tutorials/packaging-projects/
- https://docs.python-guide.org/writing/structure/
- http://nsls-ii.github.io/scientific-python-cookiecutter/philosophy.html
Developing Effective Python Documentation
- https://journals.plos.org/ploscompbiol/article?id=10.1371%2Fjournal.pcbi.1006561
- https://realpython.com/documenting-python-code/
- https://divio.com/blog/documentation
Open Source Software Practices
- http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/index.html
- https://www.joelonsoftware.com/2000/08/09/the-joel-test-12-steps-to-better-code/
- https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1002802
- https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1001745
- https://producingoss.com/en/index.html Producing Open-Source Software
Open Source Software Licenses
USGS Software and Data Acceptance Criteria
- https://www.usgs.gov/about/organization/science-support/science-quality-and-integrity/fundamental-science-practices
- https://www.usgs.gov/about/organization/science-support/office-science-quality-and-integrity/acceptable-digital
- https://code.gov/#/
Software Ecosystem
Developing a Community
- https://opensource.guide/
- https://dev.to/carlillo/how-to-reach-your-goals-1000-github-stars-in-the-first-open-source-software-337h
- https://www.altexsoft.com/blog/engineering/5-best-practices-for-managing-open-source-components/
- https://dri.es/balancing-makers-and-takers-to-scale-and-sustain-open-source
- https://opensource.com/business/14/9/community-best-practices-new-era-open-source
- https://www.nature.com/news/the-unsung-heroes-of-scientific-software-1.19100
- https://bssw.io/
- https://www.nature.com/articles/d41586-019-02046-0
Defining Interfaces
- https://restful.io/rest-api-back-to-basics-c64f282d972
- https://earthquake.usgs.gov/fdsnws/event/1/
- https://service.iris.edu/
Data Management Systems
Continuous Testing Links
Software Release Practices
- http://opensha.usc.edu/trac/wiki/ReleasingApplications
- https://www.usability.gov/how-to-and-tools/methods/system-usability-scale.html
- https://github.com/danielskatz/sustaining-research-projects
