Loading...
Searching...
No Matches
JobResult.h
Go to the documentation of this file.
1/*
2** This file is part of eOn.
3**
4** SPDX-License-Identifier: BSD-3-Clause
5**
6** Copyright (c) 2010--present, eOn Development Team
7** All rights reserved.
8**
9** Repo:
10** https://github.com/TheochemUI/eOn
11*/
12#pragma once
13
14#include "BaseStructures.h"
15
16#include <cstdint>
17#include <format>
18#include <fstream>
19#include <optional>
20#include <readcon-core.hpp>
21#include <sstream>
22#include <stdexcept>
23#include <string>
24#include <string_view>
25#include <utility>
26#include <vector>
27
28#include "magic_enum/magic_enum.hpp"
29
30namespace eonc {
31
36 std::string backend;
37 std::string engine_version;
39 std::string rgpot_name;
40 std::string rgpot_version;
41 bool xtsci{false};
42 std::uint16_t xts_abi_major{0};
43 std::uint16_t xts_abi_minor{0};
44 std::uint16_t xts_abi_layout{0};
45 bool has_eindir{false};
46 std::uint32_t eindir_abi_major{0};
47 std::uint32_t eindir_abi_minor{0};
48 std::uint32_t eindir_objective_layout{0};
49 std::uint64_t eindir_objective_size{0};
50 std::uint64_t eindir_objective_align{0};
51 std::uint32_t eindir_dlpack_major{0};
52 std::uint32_t eindir_dlpack_minor{0};
53 std::uint64_t eindir_features{0};
54
55 static constexpr std::uint16_t readcon_spec_version = 3;
56 static constexpr std::string_view readcon_min_version = "0.14.9";
57 static constexpr std::string_view eon_schema_min_version = "0.2.3";
58 static constexpr std::string_view rgpycrumbs_min_version = "1.10.4";
59 static constexpr std::string_view chemparseplot_min_version = "1.9.17";
60 static constexpr std::string_view rgpot_pin = "3.2.0";
61
62 std::string text() const {
63 if (backend.empty()) {
64 return {};
65 }
66 std::ostringstream out;
67 out << backend << " optimizer_backend\n";
68 out << "eon.optimizer.v1 optimizer_provenance_schema\n";
69 out << "eon.compatibility.v1 compatibility_schema\n";
70 out << readcon_spec_version << " compatibility_readcon_spec_version\n";
71 out << readcon_min_version << " compatibility_readcon_min_version\n";
72 out << eon_schema_min_version << " compatibility_eon_schema_min_version\n";
73 out << rgpycrumbs_min_version << " compatibility_rgpycrumbs_min_version\n";
75 << " compatibility_chemparseplot_min_version\n";
76 out << "eon engine_id\n";
77 if (!engine_version.empty()) {
78 out << engine_version << " engine_version\n";
79 }
80 if (!engine_build_identity.empty()) {
81 out << engine_build_identity << " engine_build_identity\n";
82 }
83 if (!rgpot_name.empty()) {
84 out << rgpot_name << " rgpot_name\n";
85 }
86 if (!rgpot_version.empty()) {
87 out << "eon.rgpot.v1 rgpot_schema\n";
88 out << rgpot_version << " rgpot_version\n";
89 }
90 if (xtsci) {
91 out << "eon.objective compatibility_engine_protocol_family\n";
92 out << "1 compatibility_engine_protocol_major\n";
93 out << "0 compatibility_engine_protocol_minor\n";
94 out << xts_abi_major << " compatibility_engine_abi_major\n";
95 out << xts_abi_minor << " compatibility_engine_abi_minor\n";
96 out << xts_abi_layout << " compatibility_engine_layout_revision\n";
97 out << xts_abi_major << " optimizer_xts_abi_major\n";
98 out << xts_abi_minor << " optimizer_xts_abi_minor\n";
99 out << xts_abi_layout << " optimizer_xts_abi_layout\n";
100 }
101 if (has_eindir) {
102 out << eindir_abi_major << " optimizer_eindir_abi_major\n";
103 out << eindir_abi_minor << " optimizer_eindir_abi_minor\n";
104 out << eindir_objective_layout << " optimizer_eindir_objective_layout\n";
105 out << eindir_objective_size << " optimizer_eindir_objective_size\n";
106 out << eindir_objective_align << " optimizer_eindir_objective_align\n";
107 out << eindir_dlpack_major << " optimizer_eindir_dlpack_major\n";
108 out << eindir_dlpack_minor << " optimizer_eindir_dlpack_minor\n";
109 out << eindir_features << " optimizer_eindir_features\n";
110 }
111 return out.str();
112 }
113};
114
115class Parameters;
116
119JobResultProvenance provenanceForJob(const Parameters &params);
120
125 std::string job_type;
127 std::string status_text;
128 std::string potential_type;
129 std::int64_t random_seed{-1};
130 std::uint64_t force_calls{0};
131 double potential_energy{0.0};
132 bool has_energy{false};
136 bool has_saddle{false};
137 bool has_reactant{false};
138 bool has_product{false};
140 std::uint64_t force_calls_minimization{0};
141 std::uint64_t force_calls_saddle{0};
142 std::uint64_t force_calls_prefactors{0};
148 double simulation_time{0.0};
149 double md_temperature{0.0};
150 bool has_dynamics{false};
151 std::optional<readcon::ConFrame> reactant_frame;
152 std::optional<readcon::ConFrame> saddle_frame;
153 std::optional<readcon::ConFrame> product_frame;
154 std::vector<std::pair<std::string, double>> extras;
155 std::vector<std::pair<std::string, std::string>> tags;
157
158 std::string processSearchString() const {
159 std::ostringstream out;
160 out << status_code << " termination_reason\n";
161 if (!status_text.empty()) {
162 out << status_text << " termination_reason_text\n";
163 }
164 out << random_seed << " random_seed\n";
165 if (!potential_type.empty()) {
166 out << potential_type << " potential_type\n";
167 }
168 out << force_calls << " total_force_calls\n";
169 out << force_calls_minimization << " force_calls_minimization\n";
170 out << force_calls_saddle << " force_calls_saddle\n";
171 out << std::format("{:.12e} potential_energy_saddle\n",
173 out << std::format("{:.12e} potential_energy_reactant\n",
175 out << std::format("{:.12e} potential_energy_product\n",
177 out << std::format("{:.12e} barrier_reactant_to_product\n",
179 out << std::format("{:.12e} barrier_product_to_reactant\n",
181 out << std::format("{:.12e} displacement_saddle_distance\n",
183 if (has_dynamics) {
184 out << std::format("{:.12e} simulation_time\n", simulation_time);
185 out << std::format("{:.12e} md_temperature\n", md_temperature);
186 }
187 out << force_calls_prefactors << " force_calls_prefactors\n";
188 out << std::format("{:.12e} prefactor_reactant_to_product\n",
190 out << std::format("{:.12e} prefactor_product_to_reactant\n",
192 out << provenance.text();
193 return out.str();
194 }
195
196 std::string toString() const {
198 return processSearchString();
199 }
200 std::ostringstream out;
201 out << status_code << " termination_reason\n";
202 if (!status_text.empty()) {
203 out << status_text << " termination_reason_text\n";
204 }
205 if (!job_type.empty()) {
206 out << job_type << " job_type\n";
207 }
208 if (!potential_type.empty()) {
209 out << potential_type << " potential_type\n";
210 }
211 if (random_seed >= 0) {
212 out << random_seed << " random_seed\n";
213 }
214 out << force_calls << " total_force_calls\n";
215 if (has_energy) {
216 out << std::format("{:.12e} potential_energy\n", potential_energy);
217 }
218 if (has_saddle) {
219 out << std::format("{:.12e} potential_energy_saddle\n",
221 }
222 if (has_reactant) {
223 out << std::format("{:.12e} potential_energy_reactant\n",
225 }
226 if (has_product) {
227 out << std::format("{:.12e} potential_energy_product\n",
229 }
230 for (const auto &kv : extras) {
231 out << std::format("{:.12e} {}\n", kv.second, kv.first);
232 }
233 for (const auto &kv : tags) {
234 out << kv.second << " " << kv.first << "\n";
235 }
236 out << provenance.text();
237 return out.str();
238 }
239
240 void writeResultsDat(const std::string &path) const {
241 std::ofstream out(path, std::ios::binary);
242 if (!out) {
243 throw std::runtime_error("JobResultEnvelope: cannot open " + path);
244 }
245 out << toString();
246 if (!out) {
247 throw std::runtime_error("JobResultEnvelope: write failed for " + path);
248 }
249 }
250
252 std::uint64_t fcalls, bool hasE,
253 double energy) {
255 e.job_type = "minimization";
256 e.status_code = static_cast<int>(status);
257 e.status_text = std::string(magic_enum::enum_name<RunStatus>(status));
258 e.potential_type = std::string(magic_enum::enum_name<PotType>(pot));
259 e.force_calls = fcalls;
260 e.has_energy = hasE;
261 e.potential_energy = energy;
262 return e;
263 }
264
266 int status, std::string statusText, PotType pot, std::int64_t seed,
267 std::uint64_t fMin, std::uint64_t fSaddle, std::uint64_t fPref,
268 double eSaddle, double eReactant, double eProduct, double barrierFwd,
269 double barrierRev, double displacement, double prefFwd, double prefRev,
270 bool dynamics, double simTime, double mdTemp) {
272 e.process_search_layout = true;
273 e.job_type = "process_search";
274 e.status_code = status;
275 e.status_text = std::move(statusText);
276 e.potential_type = std::string(magic_enum::enum_name<PotType>(pot));
277 e.random_seed = seed;
279 e.force_calls_saddle = fSaddle;
280 e.force_calls_prefactors = fPref;
281 e.force_calls = fMin + fSaddle + fPref;
282 e.has_saddle = true;
283 e.has_reactant = true;
284 e.has_product = true;
285 e.potential_energy_saddle = eSaddle;
286 e.potential_energy_reactant = eReactant;
287 e.potential_energy_product = eProduct;
288 e.barrier_reactant_to_product = barrierFwd;
289 e.barrier_product_to_reactant = barrierRev;
290 e.displacement_saddle_distance = displacement;
293 e.has_dynamics = dynamics;
294 e.simulation_time = simTime;
295 e.md_temperature = mdTemp;
296 return e;
297 }
298};
299
300} // namespace eonc
RAII resource manager for the ARTn C library with global synchronization.
JobResultProvenance provenanceForJob(const Parameters &params)
Optimizer backend, engine identity, rgpot pin, and xts ABI from a job.
In-memory JobResult scalars.
Definition JobResult.h:124
std::uint64_t force_calls_minimization
Definition JobResult.h:140
std::vector< std::pair< std::string, double > > extras
Definition JobResult.h:154
std::uint64_t force_calls
Definition JobResult.h:130
double barrier_product_to_reactant
Definition JobResult.h:144
double prefactor_product_to_reactant
Definition JobResult.h:146
double prefactor_reactant_to_product
Definition JobResult.h:145
std::vector< std::pair< std::string, std::string > > tags
Definition JobResult.h:155
double displacement_saddle_distance
Definition JobResult.h:147
std::uint64_t force_calls_prefactors
Definition JobResult.h:142
std::optional< readcon::ConFrame > product_frame
Definition JobResult.h:153
std::string potential_type
Definition JobResult.h:128
void writeResultsDat(const std::string &path) const
Definition JobResult.h:240
std::uint64_t force_calls_saddle
Definition JobResult.h:141
std::optional< readcon::ConFrame > saddle_frame
Definition JobResult.h:152
static JobResultEnvelope fromProcessSearch(int status, std::string statusText, PotType pot, std::int64_t seed, std::uint64_t fMin, std::uint64_t fSaddle, std::uint64_t fPref, double eSaddle, double eReactant, double eProduct, double barrierFwd, double barrierRev, double displacement, double prefFwd, double prefRev, bool dynamics, double simTime, double mdTemp)
Definition JobResult.h:265
std::string status_text
Definition JobResult.h:127
std::optional< readcon::ConFrame > reactant_frame
Definition JobResult.h:151
std::string processSearchString() const
Definition JobResult.h:158
std::string toString() const
Definition JobResult.h:196
JobResultProvenance provenance
Definition JobResult.h:156
std::int64_t random_seed
Definition JobResult.h:129
static JobResultEnvelope fromMinimization(RunStatus status, PotType pot, std::uint64_t fcalls, bool hasE, double energy)
Definition JobResult.h:251
double barrier_reactant_to_product
Definition JobResult.h:143
Optimizer, xtsci, eindir, and rgpot identity carried on a JobResult.
Definition JobResult.h:35
std::uint32_t eindir_dlpack_major
Definition JobResult.h:51
std::uint32_t eindir_abi_minor
Definition JobResult.h:47
std::uint32_t eindir_abi_major
Definition JobResult.h:46
std::string engine_build_identity
Definition JobResult.h:38
std::uint32_t eindir_dlpack_minor
Definition JobResult.h:52
static constexpr std::string_view eon_schema_min_version
Definition JobResult.h:57
std::uint16_t xts_abi_major
Definition JobResult.h:42
std::uint64_t eindir_features
Definition JobResult.h:53
std::string text() const
Definition JobResult.h:62
static constexpr std::string_view readcon_min_version
Definition JobResult.h:56
std::uint64_t eindir_objective_size
Definition JobResult.h:49
std::uint32_t eindir_objective_layout
Definition JobResult.h:48
std::string engine_version
Definition JobResult.h:37
static constexpr std::string_view rgpycrumbs_min_version
Definition JobResult.h:58
std::uint16_t xts_abi_layout
Definition JobResult.h:44
std::string rgpot_version
Definition JobResult.h:40
static constexpr std::string_view rgpot_pin
Definition JobResult.h:60
std::uint64_t eindir_objective_align
Definition JobResult.h:50
static constexpr std::uint16_t readcon_spec_version
Definition JobResult.h:55
std::uint16_t xts_abi_minor
Definition JobResult.h:43
static constexpr std::string_view chemparseplot_min_version
Definition JobResult.h:59