citations.h

Go to the documentation of this file.

/*
 *            Copyright 2009-2026 The VOTCA Development Team
 *                       (http://www.votca.org)
 *
 *      Licensed under the Apache License, Version 2.0 (the "License")
 *
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *              http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
 
#pragma once
#ifndef VOTCA_XTP_CITATIONS_H
#define VOTCA_XTP_CITATIONS_H
 
// Standard includes
#include <string>
#include <vector>
 
namespace votca {
namespace xtp {

namespace citations {
 
struct Reference {
  std::string key;
  std::string text;
  std::string doi;  // may be empty
};

struct Optional {
  std::string key;
  std::string when;
};
 
struct CalculatorEntry {
  std::vector<std::string> keys;  // every run
  std::vector<Optional> optional;
};

void Cite(const std::string& key);
std::vector<std::string> Used();
void Reset();

const std::vector<Reference>& References();
bool Exists(const std::string& key);
std::string Format(const std::string& key);

std::string Report();

CalculatorEntry ForCalculator(const std::string& name);
std::vector<std::string> Calculators();
std::string CalculatorReport(const std::string& name);
 
}  // namespace citations
}  // namespace xtp
}  // namespace votca
 
#endif  // VOTCA_XTP_CITATIONS_H