The HybriD3 project accelerates the Design, Discovery and Dissemination (D3) of new crystalline organic-inorganic hybrid semiconductors in a collaborative effort between six teams of researchers located at three major universities in the Research Triangle: Duke University, University of North Carolina Chapel Hill and North Carolina State University.
I am responsible for code refactoring and documentation instruction on meeting the project's open source goals.
Documentation Refactoring Challenges
I was introduced to this project to enable new users who wish to use and contribute to the Materials Database. The main issue was that the installation instructions themselves were laced with several deprecations. I was responsible for rewriting the documentation and refactoring the code to remove these deprecated elements.
I am currently working on these changes in the following directory: https://github.com/HybriD3-database/MatD3
I've learned that the developer instinct to re-write is usually not the most viable solutions owing to the edge case considerations made in the previous versions of the code.
Sphinx Documentation Formatting
Comments