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) format and uses Sphinx to generate the Web-based documentation.

: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 of Oak Ridge National Laboratory.

: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 engelmannc@ornl.gov with any comments or questions.

License

This work is licensed under a Creative Commons Attribution 4.0 International License. See LICENSE for more information.