Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates including column/field names for GeoJSON and Shapefiles #372

Merged
merged 11 commits into from Aug 29, 2023

Conversation

kaklise
Copy link
Collaborator

@kaklise kaklise commented Aug 25, 2023

Summary

The following PR includes documentation edits and a function that returns valid base column/field names for GeoJSON and Shapefiles which is used to document file format. Each element type (Junction, Tank, etc) now includes a _base_attributes and _optional_attributes list. The _base_attribute are used in methods like add_junction while the additional optional attributes are also used to build a water network model from the dictionary representation in from_dict.

Bug fixes:

  • Added min_vol to tanks in from_dict
  • Fixed valve connectivity warning message

Tests and documentation

  • Documentation updates

Acknowledgement

By contributing to this software project, I acknowledge that I have reviewed the software quality assurance guidelines and that my contributions are submitted under the Revised BSD License.

@kaklise kaklise requested a review from dbhart August 25, 2023 00:13
@coveralls
Copy link

Coverage Status

coverage: 84.428% (+0.08%) from 84.353% when pulling 54120e1 on kaklise:docs into 423e8cd on USEPA:main.

Copy link
Collaborator

@dbhart dbhart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these changes look appropriate and in line with review comments from sponsors

@kaklise kaklise merged commit 435d505 into USEPA:main Aug 29, 2023
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants