Difference between revisions of "Software Projects"

From SCECpedia
Jump to navigationJump to search
 
(7 intermediate revisions by 2 users not shown)
Line 10: Line 10:
 
* https://realpython.com/documenting-python-code/
 
* https://realpython.com/documenting-python-code/
 
* https://divio.com/blog/documentation
 
* https://divio.com/blog/documentation
 +
* https://www.writethedocs.org/guide/
  
 
[[Image:Screen Shot 2020-04-06 at 2.55.46 PM.png|right|150px]]
 
[[Image:Screen Shot 2020-04-06 at 2.55.46 PM.png|right|150px]]
Line 20: Line 21:
 
* https://www.joelonsoftware.com/2000/08/09/the-joel-test-12-steps-to-better-code/
 
* https://www.joelonsoftware.com/2000/08/09/the-joel-test-12-steps-to-better-code/
 
* https://github.com/agu-ossi/2019-agu-oss
 
* https://github.com/agu-ossi/2019-agu-oss
 +
* https://joss.theoj.org/
  
 
== Open Source Software Licenses ==
 
== Open Source Software Licenses ==
Line 69: Line 71:
 
== Standard Practices ==
 
== Standard Practices ==
 
SCEC is standardized software project practices:
 
SCEC is standardized software project practices:
* Design codes and distribution as python modules, packages (and libraries if that term is used)
 
 
* Standard elements in git repo (readme.md, license.txt, authors etc)
 
* Standard elements in git repo (readme.md, license.txt, authors etc)
 
* Standard git repo organization to support open-source releases and automated testing
 
* Standard git repo organization to support open-source releases and automated testing
 
* Connecting git project to run tests on commit
 
* Connecting git project to run tests on commit
* Potential build and deploy tools (ansible, others?)
+
* Process of contributing new releases to pypi, conda (conda-forge)
* Process of contributing new releases to pypy, conda (dockerhub, singularity)
 
  
 
== Related Entries ==
 
== Related Entries ==
 
*[[CME_Project]]
 
*[[CME_Project]]
*[[CSEP Working Group]
+
*[[CSEP Working Group]]
 +
* Design codes and distribution as python modules, packages (and libraries if that term is used)
 +
* Potential build and deploy tools (ansible, others?)

Latest revision as of 22:07, 7 April 2020

Collection of links related to creating software distributions

Packaging Python Projects

Developing Effective Python Documentation

Screen Shot 2020-04-06 at 2.55.46 PM.png

Open Source Software Practices

Open Source Software Licenses

USGS Software and Data Acceptance Criteria

Developing a Community

Defining Interfaces

Data Management Systems

Continuous Testing Links

Software Release Practices

Example Projects

Standard Practices

SCEC is standardized software project practices:

  • Standard elements in git repo (readme.md, license.txt, authors etc)
  • Standard git repo organization to support open-source releases and automated testing
  • Connecting git project to run tests on commit
  • Process of contributing new releases to pypi, conda (conda-forge)

Related Entries

  • CME_Project
  • CSEP Working Group
  • Design codes and distribution as python modules, packages (and libraries if that term is used)
  • Potential build and deploy tools (ansible, others?)