# software-development **Repository Path**: tianqin91/software-development ## Basic Information - **Project Name**: software-development - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-07-29 - **Last Updated**: 2024-12-01 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Software Development Best Practices for Computational Chemistry A community-oriented primer on software development best practices for modern computational chemistry. ## Table of Contents * [__Philosophy and Scope__](https://github.com/choderalab/software-development/blob/master/PHILOSOPHY_AND_SCOPE.md): Who should read this guide and what it tries to accomplish * [__Licensing Guidelines__](https://github.com/choderalab/software-development/blob/master/LICENSING_GUIDELINES.md): Start by selecting an appropriate license for your code * [__Structuring Your Project__](https://github.com/choderalab/software-development/blob/master/STRUCTURING_YOUR_PROJECT.md): Structuring your project to achieve maximum gain with minimal pain * [__Version Control__](https://github.com/choderalab/software-development/blob/master/VERSION_CONTROL.md): Manage changes to your code over time to maintain its integrity * [__Python Coding Conventions__](https://github.com/choderalab/software-development/blob/master/PYTHON_CODING.md): Follow these Python conventions to write extensible code that invites collaboration * [__Unit Testing__](https://github.com/choderalab/software-development/blob/master/UNIT_TESTING.md): Testing your code to make sure it does what you expect it to * [__Continuous Integration__](https://github.com/choderalab/software-development/blob/master/CONTINUOUS_INTEGRATION.md): Setting up continuous integration to ensure new code will not break your software * [__Documentation__](https://github.com/choderalab/software-development/blob/master/DOCUMENTATION.md): Documenting your code and its use so others (and future you!) can use it * [__Python Optimization__](https://github.com/choderalab/software-development/blob/master/PYTHON_OPTIMIZATION.md): Speeding up your Python code without losing your mind * [__Packaging and Deployment__](https://github.com/choderalab/software-development/blob/master/PACKAGING_AND_DEPLOYMENT.md): Package your code and allow others to install it with minimal hassle ## How to Contribute We welcome your contributions and suggestions for how to make these materials more useful to the community. Please feel free to comment on the [issue tracker](https://github.com/choderalab/software-development/issues) or open a [pull request](https://github.com/choderalab/software-development/pulls) to contribute. ## Contributors * [John D. Chodera](https://github.com/jchodera) - `` * [Patrick B. Grinaway](https://github.com/pgrinaway) - `` * [Andrea Rizzi](https://github.com/andrrizzi) - `` * [Gregory Ross](https://github.com/gregoryross) - `` * [Levi N. Naden](https://github.com/lnaden) - `` * [Arien ("Bas") S. Rustenburg](https://github.com/bas-rustenburg) - `` * [E. A. Rosenzweig](https://github.com/earosenz) - `` ## Acknowledgments We're grateful to the contributions of many people who helped define much of these software development practices: * [Patrick Grinaway](https://github.com/pgrinaway) * [Ariën S. ("Bas") Rustenburg](https://github.com/bas-rustenburg) * [Andrea Rizzi](https://github.com/andrrizzi) * [Levi N. Naden](https://github.com/lnaden) * [Daniel Smith](https://github.com/dgasmith) * [Jeffrey Wagner](https://github.com/j-wags) * [Robert McGibbon](https://github.com/rmcgibbo) * [Jason Swails](https://github.com/swails) * [Matthew Harrigan](https://github.com/mpharrigan) * [Kyle A. Beauchamp](https://github.com/kyleabeauchamp) * [Jan-Hendrk Prinz](https://github.com/dwhswenson) * [David W. Swenson](https://github.com/jhprinz) * [Martin K. Scherer](https://github.com/marscher) * [Antonia S. J. S. Mey](https://github.com/ppxasjsm) * [Frank Noe](https://github.com/franknoe) ## License This documentation resource is licensed under the [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). You are free to: * Share — copy and redistribute the material in any medium or format * Adapt — remix, transform, and build upon the material for any purpose, even commercially. The licensor cannot revoke these freedoms as long as you follow the license terms. You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. See the full terms of the license [here](https://creativecommons.org/licenses/by/4.0/legalcode). ## Related Guides Be sure to check out these related guides and materials: * [MolSSI Software Best Practices](https://molssi.org/education/best-practices/) * [MolSSI Education resources](https://molssi-education.github.io/resources.html) * [Software Sustainability Institute Guides](https://software.ac.uk/resources/guides) __Next Chapter:__ [Philosophy and Scope ](https://github.com/choderalab/software-development/blob/master/PHILOSOPHY_AND_SCOPE.md)