Skip to content

Commit 1de159a

Browse files
author
Doug Schmidt
authored
Merge pull request #96 from DougSchmidt-AI/feature/Issue-94-ImprovePointZillaTimeSeriesCloning
Issue-94 Improved the PointZilla Readme a bit
2 parents 1627fad + 9cab1fe commit 1de159a

File tree

1 file changed

+21
-0
lines changed
  • TimeSeries/PublicApis/SdkExamples/PointZilla

1 file changed

+21
-0
lines changed

TimeSeries/PublicApis/SdkExamples/PointZilla/Readme.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,27 @@ When time-series creation is enabled, a location will also be created if needed.
128128

129129
This mode is useful for testing, but is not recommended for production systems, since the default configurations chosen by PointZilla are likely not correct.
130130

131+
### Caveats about creating a time-series using PointZilla
132+
133+
There are a number of command line options which help you create a time-series correctly (see the "Time Series creation options" section in the `--help` page).
134+
135+
The basic rules for the setting created time-series properties are:
136+
- Use reasonable defaults when possible.
137+
- The parameter's default unit, interpolation type, and monitoring method are used as a starting point.
138+
- No gap tolerance is configured by default.
139+
- If you are copying a time-series from another AQTS system using the [`/SourceTimeSeries=`](#copying-points-from-another-time-series) option, copy as many of the source time-series properties as possible.
140+
- Any command line options you set will override any automatically inferred defaults.
141+
142+
So where does this approach fall down? What are the scenarios where using PointZilla to create and copy a time-series won't give me an exact match of the original?
143+
- PointZilla just copies the corrected points and uses those values as raw point values. You lose the entire correction history.
144+
- PointZilla can't copy the gap tolerance or interpolation type from an AQTS 3.X system. If you need a different value, you'll need to set a `/GapTolerance=` or `/InterpolationType=` command line option explicitly.
145+
146+
### I created my time-series incorrectly, oh no! What do I do now?
147+
148+
[LocationDeleter](https://github.com/AquaticInformatics/examples/blob/master/TimeSeries/PublicApis/SdkExamples/LocationDeleter/Readme.md) (aka. "DeleteZilla") is your friend here.
149+
150+
If your PointZilla command-line creates a time-series incorrectly, just use `LocationDeleter` in [Time-Series Deletion Mode](https://github.com/AquaticInformatics/examples/blob/master/TimeSeries/PublicApis/SdkExamples/LocationDeleter/Readme.md#deleting-time-series) to delete the borked time-series and try again.
151+
131152
## Appending grades and qualifiers
132153

133154
When the target time-series is a reflected time-series, any grade codes or qualifiers imported from CSV rows or manually set via the `/GradeCode` or `/Qualifiers` options will be appended along with the core timestamp and values.

0 commit comments

Comments
 (0)