Skip to content

Latest commit

 

History

History
14 lines (8 loc) · 1.51 KB

README.md

File metadata and controls

14 lines (8 loc) · 1.51 KB

GreenSteel

Repository for the project specific code and analysis related to the Green Steel project

Project vs Software

In brief, project code uses software code to conduct computational analysis. The Green Steel project utilizes HOPP and other software. Scripts and analysis that are used once and specifically relate to its project are designated project code. These scripts should be stored and aggregated into this repository. Further instructions on the organization of this repo are exhibited below. Scripts and code that are for general use and designed to be reused shall be designated software code. These scripts should not be stored in this repository and should be implemented into software code with a pull request in the respective software.

Workflow

Clone the GreenSteel repository directly. No fork is needed as user should only work on their respective files. Before pushing changes, make sure to pull from Git. This will avoid conflicts. Finally, push changes directly to main.

Collaboration

Collaboration in Green Steel shall be stored in the source directory. Individual's codes and analysis will be stored here under their name and numbered. To accomplish this, create a personal directory in src labeled with user's NREL Git ID, then scripts and analysis shall be placed in user's directory and numbered. For example, the path should look like GreenSteel/src/<NREL Git Username>/01-h2-vs-rotor-diameter. An example of the organization style desired is in src under ckiefer.