Skip to content

elastic-hub/specification

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

specification

The GEISA Specification

The GEISA Specification is an effort by the Grid Edge Interoperability and Security Alliance to define a consistent, secure, and interoperable computing environment for embedded devices at the very edge of the electric utility grid, like electric meters and distribution automation devices, for the benefit of utilities, platform vendors, and software vendors. If you would like to get involved, please head over to our Wiki page for details on participation (https://lfenergy.org/projects/geisa/). Follow the onboarding link for details about participating in our community process. You are also welcome to fork this repository and submit pull requests if you have additions or corrections you would like considered.

GEISA, the Grid Edge Interoperability and Security Alliance (https://lfenergy.org/projects/geisa/) maintains its formal specification as a set of reStructured text files, which are converted to HTML via Sphinx. See https://www.sphinx-doc.org/en/master/index.html for details on Sphinx.

Python venv creates a virtual environment so that Sphinx can be installed using its own separate packages and not break anything in the existing environment. Depending on your environment, you may need to install python venv using your system package manager.

Here are the steps that were used from a posix environment:

$ sudo apt install latexmk librsvg2-bin # or your package manager of choice

$ mkdir specification

$ cd specification

$ python3 -m venv venv

source venv/bin/activate

(venv) $ pip3 install GitPython sphinx sphinxcontrib-svg2pdfconverter

(venv) $ make all

Alternative make targets include html and latexpdf to build just those outputs.

To build a custom sphix target, use SPHINXTARGETS=foo make all.

If you are building this documentation tree from the git repository, substitute the mkdir specification with the appropriate git clone command.

About

The GEISA Specification

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 62.0%
  • TeX 23.2%
  • Makefile 12.0%
  • CSS 2.8%