Skip to content

DOC: tutorial improvements #84

Description

@fletchapin
  • I have reviewed the documentation on main here.

Location of Documentation

https://we3lab.github.io/pype-schema/hello.html

Documentation Problem

The "hello world" tutorial is too vague and could be improved with more detail.

Suggested Fix

  • Expand the intro text “A class hierarchy designed to represent configurations of process engineering systems, such as wastewater treatment or desalination plants” to explain the value and/or compare to other existing tools. E.g. “this tool allows for process flow representations within a specific facility. The structure of the network representation for a facility is analogous to the representation for larger water network representations, such as those in EPAnet or SWMM”. Needs more wordsmithing but in general just explaining more what PyPES does
  • Include some description of how to actually assign data values to a tag? Maybe I’m missing this but I wasn’t finding it.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions