https://github.com/ornl/intersect-architecture
https://github.com/ornl/intersect-architecture
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ornl/intersect-architecture
- Owner: ORNL
- License: cc-by-4.0
- Created: 2024-09-04T13:43:25.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-16T21:07:26.000Z (4 months ago)
- Last Synced: 2025-01-24T17:14:48.910Z (4 months ago)
- Language: XSLT
- Homepage: https://intersect-architecture.readthedocs.io
- Size: 67.1 MB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![CC BY 4.0][cc-by-shield]][cc-by]
# INTERSECT Architecture Documentation
The open Interconnected Science Ecosystem (INTERSECT) architecture connects
scientific instruments and robot-controlled laboratories with computing and
data resources at the edge, the Cloud or the high-performance computing center
to enable autonomous experiments, self-driving laboratories, smart
manufacturing, and artificial intelligence driven design, discovery and
evaluation. Its a novel approach consists of science use case design patterns,
a system of systems architecture, and a microservice architecture.
The INTERSECT architecture documentation is written in
[ReStructured Text (RST)](https://www.sphinx-doc.org/en/master/usage/restructuredtext/)
format and uses [Sphinx](https://www.sphinx-doc.org/) to generate the
[Web-based documentation](https://intersect-architecture.readthedocs.io).
## :hammer_and_wrench: Building the Documentation Manually
- Download and setup:
```
shell$ git clone --single-branch --branch main https://github.com/ORNL/intersect-architecture.git
shell$ cd intersect-architecture
shell$ python3 -m venv ve3
shell$ source ve3/bin/activate
shell$ pip install pip --upgrade
shell$ pip install -r requirements.txt
```
- Edit and build
```
shell$ source ve3/bin/activate
shell$ vi myfile.rst
shell$ make
```
- View in browser (e.g., using ``open`` utility on macOS)
```
shell$ open _build/index.html
```
## :trophy: Acknowledgements
Research sponsored by the [Laboratory Directed Research and Development
Program's INTERSECT Initiative](https://www.ornl.gov/intersect) of [Oak Ridge
National Laboratory](https://www.ornl.gov).
## :page_facing_up: How to Cite
Christian Engelmann,
Michael Brim,
Swen Boehm,
Olga Kuchar,
Jack Lange,
Thomas Naughton,
Patrick Widener,
Ben Mintz,
Rob Moore,
Elke Arenholz,
Scott Atchley,
Suhas Somnath, and
Rohit Srivastava.
INTERSECT Architecture Documentation.
URL: https://intersect-architecture.readthedocs.io
## :email: Contact
Please contact Christian Engelmann at [email protected] with any comments or
questions.
## License
This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by].
See LICENSE for more information.
[![CC BY 4.0][cc-by-image]][cc-by]
[cc-by]: https://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg