visit-dav / visit

VisIt - Visualization and Data Analysis for Mesh-based Scientific Data
https://visit.llnl.gov
BSD 3-Clause "New" or "Revised" License
438 stars 116 forks source link

Changes for "Getting Data Into VisIt" manual #494

Open aowen87 opened 5 years ago

aowen87 commented 5 years ago

A user reported 2 problems with the "Getting Data Into VisIt" manual. Figure 4-4 shows example "Default file name patterns" like "nc ndf". My DataBase plugin would always attempt to use the wrong reader unless I prefix this with a wildcard ".nc .ndf". Section 4.3 on "Opening your file" cautions against opening a file in the reader constructor. The documentation implies that the constructor must throw an exception if the file format cannot be read (grep for "the constructor must throw an InvalidDBTypeException exception"). However, at the SC10 VisIt tutorial, I learned that this exception can be thrown in the PopulateDatabaseMetaData. It might be helpful to state this more explicitly in the manual.

-----------------------REDMINE MIGRATION----------------------- This ticket was migrated from Redmine. As such, not all information was able to be captured in the transition. Below is a complete record of the original redmine ticket.

Ticket number: 481 Status: Pending Project: VisIt Tracker: Bug Priority: Normal Subject: Changes for "Getting Data Into VisIt" manual Assigned to: Brad Whitlock Category: - Target version: - Author: Brad Whitlock Start: 11/17/2010 Due date: % Done: 0% Estimated time: 1.00 hour Created: 11/17/2010 01:49 pm Updated: 12/01/2010 02:55 pm Likelihood: 2 - Rare Severity: 3 - Major Irritation Found in version: 2.0.0 Impact: Expected Use: OS: All Support Group: Any Description: A user reported 2 problems with the "Getting Data Into VisIt" manual. Figure 4-4 shows example "Default file name patterns" like "nc ndf". My DataBase plugin would always attempt to use the wrong reader unless I prefix this with a wildcard ".nc .ndf". Section 4.3 on "Opening your file" cautions against opening a file in the reader constructor. The documentation implies that the constructor must throw an exception if the file format cannot be read (grep for "the constructor must throw an InvalidDBTypeException exception"). However, at the SC10 VisIt tutorial, I learned that this exception can be thrown in the PopulateDatabaseMetaData. It might be helpful to state this more explicitly in the manual.

Comments:

cyrush commented 4 years ago

we should revisit when we port the GDIV manual to sphinx