src/utils/ProgressBar.cpp

/*
 * Copyright (c) 2010 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).          
 * [4]  Vardeman, Stocker & Gezelter, in progress (2010).                        
 */

#include <string>
#include <sstream>
#include <sys/ioctl.h>
#define _POSIX_SOURCE
#include <unistd.h>
#ifdef IS_MPI
#include <mpi.h>
#endif //is_mpi
#include "utils/ProgressBar.hpp"

namespace OpenMD {

  const char * progressSpinner_ = "|/-\\";

  ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
  }
  
  void ProgressBar::clear() {
#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif
      printf("\n");
      fflush(stdout);
#ifdef IS_MPI
    }
#endif
    iteration_ = 0;
    value_ = 0;
    maximum_ = -1;
    start_ = time(NULL);
  }
  
  void ProgressBar::update() {
    int width = 80;
#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif

      // only do the progress bar if we are actually running in a tty:
      if (isatty(fileno(stdout))) {        
        // get the window width:
        struct winsize w;
        ioctl(fileno(stdout), TIOCGWINSZ, &w);
        width = w.ws_col;

        // We'll use:
        // 31 characters for the completion estimate, 
        //  6 for the % complete, 
        //  2 characters for the open and closing brackets.
        
        int avail = width - 31 - 6 - 2;
        
        ++iteration_;
        
        if (maximum_ > 0.0) {

          // we know the maximum, so draw a progress bar
          
          RealType percent = value_ * 100.0 / maximum_;
          int hashes = int(percent * avail / 100.0);
          std::string progressbar;
          progressbar.assign(hashes, '#');
          
          // add the spinner to the end of the progress bar:
          progressbar += progressSpinner_[iteration_ & 3];
          
          // compute the best estimate of the ending time:
          time_t current_ = time(NULL);
          time_t end_ = start_ + (current_ - start_) * (100.0/percent);
          struct tm * ender = localtime(&end_);
          char buffer[24];
          strftime(buffer, 24, "%a %b %d @ %I:%M %p", ender);
          
          std::stringstream fmt;
          fmt << "\r%3d%% [%-" << avail << "s] Estimate: %s";
          std::string st = fmt.str();
          
          printf(st.c_str(), int(percent),
                 progressbar.c_str(),
                 buffer);
          
        } else {
          // we don't know the maximum, so we can't draw a progress bar
          int center = (iteration_ % 48) + 1; // 50 spaces, minus 2
          std::string before;
          std::string after;
          before.assign(std::max(center - 2, 0), ' ');
          after.assign(std::min(center + 2, 50), ' ');
          
          printf("\r[%s###%s]            ",
                 before.c_str(), after.c_str());
        }
        fflush(stdout);
      }
#ifdef IS_MPI
    }
#endif
  }
  
  void ProgressBar::setStatus(RealType val, RealType max) {
    value_ = val;
    maximum_ = max;
  }  
}
Revision:	1421
Committed:	Tue Mar 30 15:04:19 2010 UTC (15 years, 7 months ago) by gezelter
File size:	4971 byte(s)
Log Message:	ProgressBar should only print status when it is actually attached to a tty. This should quiet down those background jobs.
#	User	Rev	Content
1	gezelter	1413	/*
2			* Copyright (c) 2010 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9			* 1. Redistributions of source code must retain the above copyright
10			* notice, this list of conditions and the following disclaimer.
11			*
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31			*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38			* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 24107 (2008).
39			* [4] Vardeman, Stocker & Gezelter, in progress (2010).
40			*/
41
42			#include <string>
43			#include <sstream>
44			#include <sys/ioctl.h>
45	gezelter	1421	#define _POSIX_SOURCE
46			#include <unistd.h>
47	gezelter	1413	#ifdef IS_MPI
48			#include <mpi.h>
49			#endif //is_mpi
50			#include "utils/ProgressBar.hpp"
51
52			namespace OpenMD {
53
54			const char * progressSpinner_ = "\|/-\\";
55
56			ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
57			}
58
59			void ProgressBar::clear() {
60			#ifdef IS_MPI
61			if (MPI::COMM_WORLD.Get_rank() == 0) {
62			#endif
63			printf("\n");
64			fflush(stdout);
65			#ifdef IS_MPI
66			}
67			#endif
68			iteration_ = 0;
69			value_ = 0;
70			maximum_ = -1;
71			start_ = time(NULL);
72			}
73
74			void ProgressBar::update() {
75			int width = 80;
76			#ifdef IS_MPI
77			if (MPI::COMM_WORLD.Get_rank() == 0) {
78			#endif
79
80	gezelter	1421	// only do the progress bar if we are actually running in a tty:
81			if (isatty(fileno(stdout))) {
82			// get the window width:
83			struct winsize w;
84			ioctl(fileno(stdout), TIOCGWINSZ, &w);
85			width = w.ws_col;
86	gezelter	1413
87	gezelter	1421	// We'll use:
88			// 31 characters for the completion estimate,
89			// 6 for the % complete,
90			// 2 characters for the open and closing brackets.
91
92			int avail = width - 31 - 6 - 2;
93
94			++iteration_;
95
96			if (maximum_ > 0.0) {
97	gezelter	1413
98	gezelter	1421	// we know the maximum, so draw a progress bar
99
100			RealType percent = value_ * 100.0 / maximum_;
101			int hashes = int(percent * avail / 100.0);
102			std::string progressbar;
103			progressbar.assign(hashes, '#');
104
105			// add the spinner to the end of the progress bar:
106			progressbar += progressSpinner_[iteration_ & 3];
107
108			// compute the best estimate of the ending time:
109			time_t current_ = time(NULL);
110			time_t end_ = start_ + (current_ - start_) * (100.0/percent);
111			struct tm * ender = localtime(&end_);
112			char buffer[24];
113			strftime(buffer, 24, "%a %b %d @ %I:%M %p", ender);
114
115			std::stringstream fmt;
116			fmt << "\r%3d%% [%-" << avail << "s] Estimate: %s";
117			std::string st = fmt.str();
118
119			printf(st.c_str(), int(percent),
120			progressbar.c_str(),
121			buffer);
122
123			} else {
124			// we don't know the maximum, so we can't draw a progress bar
125			int center = (iteration_ % 48) + 1; // 50 spaces, minus 2
126			std::string before;
127			std::string after;
128			before.assign(std::max(center - 2, 0), ' ');
129			after.assign(std::min(center + 2, 50), ' ');
130
131			printf("\r[%s###%s] ",
132			before.c_str(), after.c_str());
133			}
134			fflush(stdout);
135			}
136	gezelter	1413	#ifdef IS_MPI
137			}
138			#endif
139			}
140
141			void ProgressBar::setStatus(RealType val, RealType max) {
142			value_ = val;
143			maximum_ = max;
144			}
145			}