Merge pull request #711 from yandthj/lex_documentation

Lex documentation

docs/Documentation/Resource_Management_System/index.md

@@ -0,0 +1,58 @@
+# Lex Allocation Management System
+*Lex is a system for managing your high-performance computing (HPC) resource assignments, account information, and tracking utilization.*
+
+
+## Access
+
+An [NREL HPC account](https://www.nrel.gov/hpc/user-accounts.html) is required to access Lex. To log in to Lex, open a web browser to [https://hpcprojects.nrel.gov](https://hpcprojects.nrel.gov/login/?next=/). Log in with your NREL HPC username and password. An OTP token is not required to authenticate. 
+
+## Requesting an Allocation
+
+The system resource allocation request form is available on Lex. For further information on allocations and how to request one, please visit the [Resource Allocations page.](https://www.nrel.gov/hpc/resource-allocation-requests.html)  
+
+## Managing Users
+
+The allocation PI, Project Lead, and Alternate Project Lead can use Lex to manage the allocation entitlement list. 
+
+To add and remove users, navigate to the "Manage Users" page for the allocation.
+![image](../../assets/images/Lex/lex-manage-users-nav.png)
+
+To add users, click the "Add User" button and enter the user's email. Repeat for any additional users. Click "Delete" to remove users from the allocation entitlement list.
+**Be sure to click "Submit Changes" to apply your changes.**
+
+![image](../../assets/images/Lex/lex-manage-users.png)
+
+
+Users who have an existing NREL HPC account will be added to the allocation group and permissions will be granted within 24 hours. 
+Otherwise, they will be sent an email invitation to request an account and will be listed in the "Pending Invitations" list until their account has been created. You can cancel an invitation by selecting the "Cancel" button and clicking "Submit Changes". 
+
+## Tracking Allocation Usage
+
+### AU Usage Data 
+
+The sidebar on the Lex homepage shows all of the allocations that you have access to. Select a project to check the resource usage.
+
+![image](../../assets/images/Lex/lex_nav.png)
+
+On the "AU Use Report" page, the "Project Use" section lists all of the systems that the project has an allocation on and corresponding AU usage. The "AUs Charged by User" section provides a breakdown of AU usage by user for the project. By default, the data displayed shows each user's total usage across all systems. To filter this to show data for a specific system, use the system button as shown below. 
+
+
+![image](../../assets/images/Lex/lex_aus_by_user.png)
+
+### Jobs Data
+
+To see the list of jobs run using the allocation, select the "List Jobs" tab. 
+
+![image](../../assets/images/Lex/lex_au_use_report.png)
+
+To filter the job data, such as by a specific user or partition, use the search bar. Click the column headers to sort the list by that feature. 
+
+![image](../../assets/images/Lex/lex-jobs-search.png)
+
+
+To see a summary about a job, click the job ID.
+
+![image](../../assets/images/Lex/lex-job-details.png)
+
+
+For any questions or feedback on Lex, please contact [[email protected]](mailto:[email protected]).

mkdocs.yml

@@ -14,6 +14,8 @@ nav:
       - Documentation Home: Documentation/index.md
       - Getting Started: Documentation/getting_started.md
       - Help and Support: Documentation/help.md
+      - Allocation Management System:
+        - Documentation/Resource_Management_System/index.md
       - Systems: 
         - Systems: Documentation/Systems/index.md
         - Kestrel: