open223 / docs.open223.info Goto Github PK

https://diataxis.fr/explanation/

Explanation is discussion that clarifies and illuminates a particular topic. Explanation is understanding-oriented.

Here are the ones that were listed in the original intro.md (landing/root page) for discussion.

• Explanation
  • Introduce 223P and classes at a high level
  • Supporting Technologies

@MatthewSteen @gtfierro

Creating an issue for explore documentation.

@MatthewSteen I have added figures subdirectory under guides. Feel free to move it somewhere else.
@lazlop Do you still want to keep the text you have added for this section
@steveraysteveray Feel free to edit my text

...and in the darkness bind them

GitHub will automagically copy and create a README in the root dir of the repo if one exists in docs/README.md, which is what https://github.com/NREL/BuildingMOTIF/blob/develop/docs/README.md does. This is something we could consider doing but would require moving all the files into a docs dir.

FYI @pdelgosha22 @gtfierro @lazlop @steveraysteveray

https://diataxis.fr/reference/

Reference guides are technical descriptions of the machinery and how to operate it. Reference material is information-oriented.

Here are the ones that were listed in the original intro.md (landing/root page) for discussion.

• Reference
  • Supporting Technologies References
    • Links documentation to SHACL, RDFS, RDF, SPARQL, etc.
  • Publication document?
  • Available Tools
  • Open 223
    • Explore 223
    • Query 223

https://diataxis.fr/tutorials-how-to/#understanding-the-distinction

A tutorial’s purpose is to help the pupil acquire basic competence.

@steveraysteveray @pdelgosha22 @gtfierro @MatthewSteen

What are your thoughts on a tutorial on some of the basic processes for using 223P accomplished using RDFLib? I outlined this in this file. I think it may be helpful to have a more "beginning to end" type of tutorial to show people how to interact with 223P models, but I'm not sure exactly what should be included in this. Please edit the file or let me know what you think in this issue!

https://osr.ashrae.org/Online-Comment-Database/ShowDoc2/Table/DocumentAttachments/FileName/4301-223P_APRDraft.pdf/download/false

Dedicated issue for Tutorial 1 (see #7).

• G36 4.2 VAVR is probably the best candidate. https://github.com/open223/models.open223.info/blob/add/g36-4.2/models/g36-extensions-vav-reheat.ttl

Model Loading

1. Parsing an existing model (fetch from a raw GitHub url in the models.open223.info?)
   Describing the model and linking to relevant classes, e.g. https://explore.open223.info/brick/Variable_Air_Volume_Box_With_Reheat.html.
2. A couple/few basic operations on the model.
   For example, performing a query using RDFLib and https://query.open223.info/.

As discussed in #7 and meeting, Tutorial 2 = Model Inferencing.

Creating an issue for query.open223 documentation.

@gtfierro @MatthewSteen
@wehuang16 and I have started a tutorial for this based on what we discussed in the last meeting.

Add user guide from https://bas-im.emcs.cornell.edu/223/223standard/-/wikis/User-Guide.

Issue to discuss what files/pages to include in the top level Guides section.

https://diataxis.fr/tutorials-how-to/#understanding-the-distinction

A how-to guide’s purpose is to help the already-competent user perform a particular task correctly.

FYI @lazlop, @pdelgosha22, @steveraysteveray, @gtfierro