Engineering Papers⌕ Search

SEARCH · Engineering Papers

Results for “GitLab”

Search indexed NASA NTRS and DOE OSTI research on propulsion, heat transfer, battery materials and energy systems. Follow report and document links to the original sources.

Quote a phrase for an exact phrase match. Source license links do not imply unrestricted reuse.

60 records · Page 4

Best practices for documenting a scientific Python project

Documentation is a crucial component of software development that helps users with installation and usage of the software. Documentation also helps onboard new developers to a software project with contributing guidelines and API information. The INTERSECT project is an open federated hardware/software library to facilitate the development of au- tonomous laboratories. A documentation strategy using Sphinx has been utilized to help developers contribute to source code and to help users understand the INTERSECT Python interface. Docstrings as well as reStructuredText files are used by Sphinx to automatically compile HTML and PDF files which can be hosted online as API documentation and user guides. The resulting documentation website is automatically built and deployed using GitLab runners to create Docker containers with NGINX servers. The approach discussed in this paper to automatically deploy documentation for a Python project can improve the user and developer experience for many scientific projects.

Wiggins, Gavin↗

NDNSEG (Named Data Network Scalable Environment Generator) [SWR-21-91]

NDNSEG (Named Data Network Scalable Environment Generator) automates the deployment of NDN environments in NREL's Cyber-Energy Emulation Platform (CEEP). Specifying the number of clients, servers, gateways, and pv_inverters and running NDNSEG will automate the generation of required files to deploy the number of specified virtual machines, the underlying networking infrastructure, and configuration for GitLab CI/CD.

Peterson, Jordan↗