SAM/src/wavetoolkit.cpp at patch · pks3/SAM

491 lines (412 loc) · 18.2 KB
BSD 3-Clause License
Copyright (c) Alliance for Sustainable Energy, LLC. See also https://github.com/NREL/SAM/blob/develop/LICENSE
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted 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.
3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#include<algorithm>
#include <wx/checklst.h>
#include <wx/combobox.h>
#include <wx/textctrl.h>
#include <wx/valtext.h>
#include <wx/sizer.h>
#include <wx/dirdlg.h>
#include <wx/progdlg.h>
#include <wx/checkbox.h>
#include <wx/tokenzr.h>
#include <wx/srchctrl.h>
#include <wex/easycurl.h>
#include <rapidjson/document.h>
#include "wavetoolkit.h"
#include "geotools.h"
#include "main.h"
static const char* help_text =
"NREL Wave Toolkit data is only available for locations in the continental United States. Each weather file contains wave resource data for a single year.\n\n"
"See Help for details.";
	ID_txtAddress, ID_txtFolder, ID_cboFilter, /*ID_cboWeatherFile,*/ ID_chlResources,
	ID_btnSelectAll, ID_btnClearAll, ID_btnSelectFiltered, ID_btnShowSelected, ID_btnShowAll, ID_btnResources, ID_btnFolder, ID_search, ID_radAddress, ID_radLatLon, ID_txtLat, ID_txtLon,
    ID_cboYears, ID_lstYears, ID_radSingleYear, ID_radMultiYear, ID_radAllYear, ID_cboSingleYear, ID_txtSingleYear, ID_txtStartYear, ID_txtEndYear, ID_cboEndpoint, ID_allyear_chk
BEGIN_EVENT_TABLE( WaveDownloadDialog, wxDialog )
	EVT_BUTTON(ID_btnFolder, WaveDownloadDialog::OnEvt)
    EVT_RADIOBUTTON(ID_radSingleYear, WaveDownloadDialog::OnEvt)
    EVT_RADIOBUTTON(ID_radMultiYear, WaveDownloadDialog::OnEvt)
    EVT_RADIOBUTTON(ID_radAllYear, WaveDownloadDialog::OnEvt)
	//EVT_BUTTON(wxID_OK, WaveDownloadDialog::OnEvt)
	EVT_CHECKLISTBOX(ID_chlResources, WaveDownloadDialog::OnEvt)
	EVT_BUTTON(wxID_HELP, WaveDownloadDialog::OnEvt)
END_EVENT_TABLE()
WaveDownloadDialog::WaveDownloadDialog(wxWindow *parent, const wxString &title)
	 : wxDialog( parent, wxID_ANY, title,  wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER )
	wxString dnpath;
    dnpath = ::wxGetHomeDir() + "/SAM Downloaded Weather Files";
	m_txtFolder = new wxTextCtrl(this, ID_txtFolder, dnpath, wxDefaultPosition, wxDefaultSize, 0);// , wxDefaultPosition, wxSize(500, 30));
	m_txtFolder->SetValue(dnpath);
    m_btnFolder = new wxButton(this, ID_btnFolder, "...", wxDefaultPosition, wxSize(30, 30));
	//m_txtAddress = new wxTextCtrl(this, ID_txtAddress, "40.842,-124.25");// , wxDefaultPosition, wxSize(500, 30));
    wxBoxSizer* szFolder = new wxBoxSizer(wxHORIZONTAL);
    szFolder->Add(new wxStaticText(this, wxID_ANY, "Choose download folder:"), 0, wxALL, 10);
    szFolder->Add(m_txtFolder, 5, wxALL | wxEXPAND, 2);
    szFolder->Add(m_btnFolder, 0, wxALL, 2);
    wxBoxSizer* szEndpoint = new wxBoxSizer(wxHORIZONTAL);
    wxArrayString endpoints;
    endpoints.Add("U.S. West Coast");
    endpoints.Add("U.S. Atlantic Coast");
    endpoints.Add("Hawaii");
    endpoints.Add("Alaska");
    wxString InitialValue = "U.S. West Coast";
    cboEndpoint = new wxComboBox(this, ID_cboEndpoint, InitialValue, wxDefaultPosition, wxDefaultSize, endpoints, wxCB_READONLY);
    szEndpoint->Add(new wxStaticText(this, wxID_ANY, "Select dataset"), wxALL, 15);
    szEndpoint->Add(cboEndpoint, 0, wxALL, 5);
    wxArrayString years;
    wxArrayString list_years;
    for (int x = 1979; x < 2011; x++) {
        wxString year_string = std::to_string(x);
        years.Add(year_string);
        list_years.Add(year_string);
    radSingleYear = new wxRadioButton(this, ID_radSingleYear, "Choose a single year");
    cboSingleYear = new wxComboBox(this, ID_cboSingleYear, "2010", wxDefaultPosition, wxDefaultSize, list_years, wxCB_READONLY);
    //txtSingleYear = new wxTextCtrl(this, ID_txtSingleYear, "2010", wxDefaultPosition, wxDefaultSize, 0, ::wxTextValidator(wxFILTER_NUMERIC));
    radMultiYear = new wxRadioButton(this, ID_radMultiYear, "Choose years");
    txtStartYear = new wxTextCtrl(this, ID_txtStartYear, "1979", wxDefaultPosition, wxDefaultSize, 0, ::wxTextValidator(wxFILTER_NUMERIC));
    txtEndYear = new wxTextCtrl(this, ID_txtEndYear, "1990", wxDefaultPosition, wxDefaultSize, 0, ::wxTextValidator(wxFILTER_NUMERIC));
    radAllYear = new wxRadioButton(this, ID_radAllYear, "Download all years (1979-2010)");
    txtLat = new wxTextCtrl(this, ID_txtLat, "46.2", wxDefaultPosition, wxDefaultSize, 0, ::wxTextValidator(wxFILTER_NUMERIC));
    txtLon = new wxTextCtrl(this, ID_txtLon, "-124.2", wxDefaultPosition, wxDefaultSize, 0, ::wxTextValidator(wxFILTER_NUMERIC));
	wxString msg = "Use this window to list all weather files available from the USWave dataset for a given location, and choose files to download and add to your wave resource library.\n";
	msg += "Type a latitude and longtitude, for example, \"40.842,-124.25\", and click Find to list available files.\n";
	msg += "When the list appears, select the file or files you want to download, or use the filter and auto-select buttons to find and select files.\n";
	msg += "Choose the download folder where you want SAM to save files, or use the default SAM Downloaded Weather Files folder.\n";
	msg += "SAM automatically adds the folder to the list of folders it uses to populate your wave resource library.\n";
	msg += "Click OK to download the selected files and add them to your wave resource library.";
    //lstYears = new wxListBox(this, ID_lstYears, wxDefaultPosition, wxDefaultSize, list_years, wxLB_MULTIPLE);
    //all_years_chk = new wxCheckBox(this, ID_allyear_chk, "Download all years");
    wxBoxSizer* szll = new wxBoxSizer(wxHORIZONTAL);
    szll->Add(new wxStaticText(this, wxID_ANY, "Enter desired location coordinates: "), 0, wxALL , 5);
    szll->Add(new wxStaticText(this, wxID_ANY, "Latitude"), 0, wxALL , 5);
    szll->Add(txtLat, 0, wxALL, 5);
    szll->Add(new wxStaticText(this, wxID_ANY, "Longitude"), 0, wxALL , 5);
    szll->Add(txtLon, 0, wxALL, 5);
    wxBoxSizer* szgrid = new wxBoxSizer(wxHORIZONTAL);
    szgrid->Add(szll, 0, wxALL | wxEXPAND , 1);
    wxBoxSizer* szyr = new wxBoxSizer(wxHORIZONTAL);
    szyr->Add(new wxStaticText(this, wxID_ANY, "Select years to download"), wxALL | wxALIGN_CENTER_VERTICAL, 15);
    szyr->Add(lstYears, 0, wxALL, 5);
    szyr->Add(all_years_chk, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5);
    wxBoxSizer* szmultyr = new wxBoxSizer(wxHORIZONTAL);
    szmultyr->Add(new wxStaticText(this, wxID_ANY, "Start year"), 0, wxALL , 5);
    szmultyr->Add(txtStartYear, 0, wxALL, 5);
    szmultyr->Add(new wxStaticText(this, wxID_ANY, "End year"), 0, wxALL , 5);
    szmultyr->Add(txtEndYear, 0, wxALL, 5);
    wxBoxSizer* szyr = new wxBoxSizer(wxHORIZONTAL);
    szyr->Add(radSingleYear, 0, wxALL , 5);
    szyr->Add(cboSingleYear, 0, wxALL , 1);
    szyr->Add(radMultiYear, 0, wxALL, 10);
    szyr->Add(szmultyr, 0, wxALL | wxEXPAND , 1);
    szyr->Add(radAllYear, 0, wxALL , 10);
    wxBoxSizer* szmain = new wxBoxSizer(wxVERTICAL);
    szmain->Add(new wxStaticText(this, wxID_ANY, msg), 0, wxALL | wxEXPAND, 10);
    szmain->Add(szEndpoint, 0, wxALL, 10);
    szmain->Add(szgrid, 0, wxALL | wxEXPAND, 10);
    szmain->Add(szyr, 0, wxALL | wxEXPAND, 10);
    szmain->Add(szFolder, 0, wxALL | wxEXPAND, 10);
    wxStaticText* note = new wxStaticText(this, wxID_ANY, help_text);
    note->Wrap(550);
    szmain->Add(note, 0, wxLEFT | wxRIGHT | wxALIGN_CENTER, 10);
    szmain->Add(CreateButtonSizer(wxHELP | wxOK | wxCANCEL), 0, wxALL | wxEXPAND, 10);
    SetSizer(szmain);
    radSingleYear->SetValue(true);
    radMultiYear->SetValue(false);
    radAllYear->SetValue(false);
    //radMultiYear->SetValue(false);
    //radAllYear->SetValue(false);
    //txtSingleYear->Enable(true);
    //txtSingleYear->SetFocus();
    //txtSingleYear->SelectAll();
    cboSingleYear->Enable(true);
    txtStartYear->Enable(false);
    txtEndYear->Enable(false);
    txtLat->Enable(true);
    txtLon->Enable(true);
    //lstYears->Enable(true);
void WaveDownloadDialog::OnEvt( wxCommandEvent &e )
	switch( e.GetId() )
		case wxID_HELP:
			SamApp::ShowHelp("wave_download");
        case ID_radSingleYear:
        case ID_radMultiYear:
        case ID_radAllYear:
                bool singleYear = radSingleYear->GetValue();
                bool multiYear = radMultiYear->GetValue();
                //txtSingleYear->Enable(singleYear);
                cboSingleYear->Enable(singleYear);
                txtStartYear->Enable(multiYear);
                txtEndYear->Enable(multiYear);
            break;
		case ID_btnFolder:
				wxDirDialog dlg(SamApp::Window(), "Choose Download Folder", m_txtFolder->GetValue(), wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST);
				if (dlg.ShowModal() == wxID_OK)
					m_txtFolder->SetValue( dlg.GetPath());
                    m_weatherFolder = m_txtFolder->GetValue();
                    //m_weatherFolder = m_txtFolder->GetValue();
					//SamApp::Settings().Write("wave_data_paths", dlg.GetPath());
                    wxArrayString paths;
                    wxString buf;
                    if (SamApp::Settings().Read("wave_data_paths", &buf))
                        paths = wxStringTokenize(buf, ";");
                    if (paths.Index(m_weatherFolder) == wxNOT_FOUND)
                        paths.Add(m_weatherFolder);
                        SamApp::Settings().Write("wave_data_paths", wxJoin(paths, ';'));
size_t WaveDownloadDialog::SelectItems( wxString str_filter, wxCheckBox *check_box )
	size_t count = 0;
	size_t item_first = 0;
	if (m_chlResources->IsEmpty()) wxMessageBox("No files to choose. Type a location and click Find to find files.", "Wave Download Message", wxOK, this);
		for (size_t i = 0; i < m_links.size(); i++)
			m_links[i].is_visible = true;
			if (m_links[i].display.Lower().Contains(str_filter) && check_box->IsChecked())
				if (count == 0) item_first = i;
				m_links[i].is_selected = true;
				count++;
			else if (m_links[i].display.Lower().Contains(str_filter) && !check_box->IsChecked()) m_links[i].is_selected = false;
	return item_first;
void WaveDownloadDialog::RefreshList( size_t first_item )
	m_chlResources->Freeze();
	m_chlResources->Clear();
	for (size_t i = 0; i < m_links.size(); i++)
		if (m_links[i].is_visible)
			int ndx = m_chlResources->Append(m_links[i].display);
			if (m_links[i].is_selected)
				m_chlResources->Check(ndx, true);
				m_chlResources->Check(ndx, false);
	m_chlResources->Thaw();
	m_chlResources->SetFirstItem(first_item);
wxString WaveDownloadDialog::GetEndpoint()
    return cboEndpoint->GetStringSelection();
wxArrayString WaveDownloadDialog::GetMultiYear()
    wxArrayString my;
    //int all_years = all_years_chk->GetValue();
    if (radSingleYear->GetValue() == 1) {
        //my.Add(txtSingleYear->GetValue());
        my.Add(cboSingleYear->GetStringSelection());
    else if (radMultiYear->GetValue() == 1) {
        wxString startyear = txtStartYear->GetValue();
        wxString endyear = txtEndYear->GetValue();
        int year_iter = std::numeric_limits<int>::quiet_NaN();
        double startyear_num = std::numeric_limits<double>::quiet_NaN();
        double endyear_num = std::numeric_limits<double>::quiet_NaN();
        startyear.ToDouble(&startyear_num);
        endyear.ToDouble(&endyear_num);
        year_iter = int(startyear_num);
        while (year_iter <= int(endyear_num)) {
            my.Add(wxString::Format(wxT("%i"), year_iter));
            year_iter++;
    else if (radAllYear->GetValue() == 1) {
        for (size_t i = 1979; i < 2011; i++)
            my.Add(wxString::Format(wxT("%i"), int(i)));
    return my;
bool WaveDownloadDialog::IsSingleYear()
    return radSingleYear->GetValue();
double WaveDownloadDialog::GetLatitude()
    double num = std::numeric_limits<double>::quiet_NaN();
    txtLat->GetValue().ToDouble(&num);
    return num;
double WaveDownloadDialog::GetLongitude()
    double num = std::numeric_limits<double>::quiet_NaN();
    txtLon->GetValue().ToDouble(&num);
    return num;
void WaveDownloadDialog::GetResources()
	// hit api with address and return available resources
	wxString location = m_txtAddress->GetValue();
	if (location == "")
		wxMessageBox("Type a latitude-longitude pair (lat, lon), street address, or location name and click Find.", "Wave Download Message", wxOK, this);
	wxString locname = "";
	bool is_addr = false;
	const wxChar* locChars = location.c_str();
	for (int i = 0; i < (int)location.Len(); i++) 
		if (isalpha(locChars[i]))
			is_addr = true;
	double lat, lon;
	if (is_addr)	//entered an address instead of a lat/long
		// use GeoTools::GeocodeGoogle for non-NREL builds and set google_api_key in private.h
		if (!GeoTools::GeocodeDeveloper(location, &lat, &lon))
			wxMessageBox("Failed to geocode address.\n\n" + location, "Wave Download Message", wxOK, this);
			locname = wxString::Format("lat_%.5lf_lon_%.5lf", lat, lon);
		wxArrayString parts = wxSplit(location, ',');
		if (parts.Count() < 2)
			wxMessageBox("Type a valid latitude-longitude (lat, lon), street address, or location name.", "Wave Download Message", wxOK, this);
			return ;
			parts[0].ToDouble(&lat);
			parts[1].ToDouble(&lon);
			locname = wxString::Format("lat_%.5lf_lon_%.5lf", lat, lon);
	//Create URL for weather file download
	wxString url;
	url = SamApp::WebApi("wave_query");
	url.Replace("<LAT>", wxString::Format("%lg", lat), 1);
	url.Replace("<LON>", wxString::Format("%lg", lon), 1);
	//Download the weather file
	wxEasyCurl curl;
	bool ok = curl.Get(url, "Getting list of available files from USWave dataset...", SamApp::Window());
		wxMessageBox("Wave Data Query failed.\n\nThere may be a problem with your internet connection,\nor the USWave web service may be down.", "Wave Download Message", wxOK, this);
#ifdef __DEBUG__
	wxLogStatus("url: %s", (const char *)url.c_str());
	wxString json_data = curl.GetDataAsString();
	if (json_data.IsEmpty())
		wxMessageBox("Wave Data Query failed.\n\nJSON data empty.\nPlease try again and contact SAM Support if you continue to have trouble.", "Wave Download Message", wxOK, this);
	rapidjson::Document reader;
	reader.Parse(json_data.c_str());
	if (reader.HasParseError())
		wxMessageBox("Wave Data Query failed.\n\nCould not process JSON from Wave Data Query response for\n" + location + "\n\nPlease try again and contact SAM Support if you continue to have trouble.", "Wave Download Message", wxOK, this);
	if (reader.HasMember("metadata"))
		if (reader["metadata"].HasMember("resultset"))
			if (reader["metadata"]["resultset"].HasMember("count"))
				if (reader["metadata"]["resultset"]["count"].IsInt())
					if (reader["metadata"]["resultset"]["count"].GetInt() == 0) {
							wxMessageBox("No Weather Files Found.\n\nWave Data Query did not return any files for\n" + location, "Wave Download Message", wxOK, this);
							return;
	if (reader.HasMember("error"))
		if (reader["error"].HasMember("message") && reader["error"].HasMember("code"))
			if (reader["error"]["message"].IsString() && reader["error"]["code"].IsString()) {
				wxString message = reader["error"]["message"].GetString();
				wxString code = reader["error"]["code"].GetString();
				wxMessageBox(wxString::Format("NSRDB API error!\n\nMessage: %s\n\nCode: %s ", message.c_str(), code.c_str()));
				return;
	// format location to use in file name
	location.Replace("\\", "_"); 
	location.Replace("/", "_"); 
	location.Replace(" ", "_");
	location.Replace(",", "_");
	location.Replace("(", "_"); 
	location.Replace(")", "_");
	location.Replace("__", "_");
	m_chlResources->Clear();
	m_links.clear();
	if (!reader.HasMember("outputs")) return; // error message?
	if (!reader["outputs"].IsArray()) return; // error message?
	auto output_list = reader["outputs"].GetArray();
	for (size_t i_outputs = 0; i_outputs<output_list.Size(); i_outputs++)
		if (!output_list[i_outputs].HasMember("links")) return; // error message?
		if (!output_list[i_outputs]["links"].IsArray()) return; // error message?
		auto links_list = output_list[i_outputs]["links"].GetArray();
		for (size_t i_links = 0; i_links < links_list.Size(); i_links++)
			// check for validity
			wxString name = output_list[i_outputs]["name"].GetString();
			wxString displayName = output_list[i_outputs]["displayName"].GetString();
			wxString year, interval;
			if (links_list[i_links]["year"].IsInt())
				year = wxString::Format("%d", links_list[i_links]["year"].GetInt());
			if (links_list[i_links]["interval"].IsInt())
				interval = wxString::Format("%d", links_list[i_links]["interval"].GetInt());
			wxString URL = links_list[i_links]["link"].GetString();
			URL.Replace("yourapikey", "<SAMAPIKEY>");
			URL.Replace("youremail", "<USEREMAIL>");
#ifdef __DEBUG__
			wxLogStatus("link info: %s, %s, %s, %s, %s, %s", displayName.c_str(), name.c_str(), /*type.c_str(),*/ year.c_str(), interval.c_str(), URL.c_str());
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

wavetoolkit.cpp

Latest commit

History

wavetoolkit.cpp

File metadata and controls
