Files
leonarski_f 4809c1622c
Build Packages / build:portable:linux-x86_64:nocuda (push) Successful in 16m43s
Build Packages / build:jfjoch:ubuntu2404:nocuda (push) Successful in 28m46s
Build Packages / build:jfjoch:rocky8:cuda-sls9 (push) Successful in 32m5s
Build Packages / build:jfjoch:rocky9:cuda (push) Successful in 39m44s
Build Packages / build:portable:macos-arm64:nocuda (push) Successful in 5m7s
Build Packages / Create release (push) Successful in 8s
Build Packages / Build documentation (push) Successful in 49s
Build Packages / build:portable:linux-x86_64:cuda (push) Successful in 22m30s
Build Packages / build:jfjoch:rocky8:nocuda (push) Successful in 31m54s
Build Packages / build:rugnux:linux-aarch64:cuda (push) Successful in 11m29s
Build Packages / build:portable:windows-x86_64:nocuda (push) Successful in 23m51s
Build Packages / build:jfjoch:ubuntu2204:nocuda (push) Successful in 26m7s
Build Packages / build:jfjoch:ubuntu2204:cuda (push) Successful in 29m38s
Build Packages / build:portable:windows-x86_64:cuda (push) Successful in 28m6s
Build Packages / HDF5 consumer tests (DIALS, XDS) (push) Successful in 29m44s
Build Packages / build:jfjoch:rocky9:nocuda (push) Successful in 33m22s
Build Packages / Generate python client (push) Successful in 47s
Build Packages / build:jfjoch:rocky9:cuda-sls9 (push) Successful in 34m6s
Build Packages / Unit tests (push) Successful in 1h2m47s
Build Packages / build:jfjoch:rocky8:cuda (push) Successful in 35m59s
Build Packages / build:jfjoch:ubuntu2404:cuda (push) Successful in 34m8s
Build Packages / Validation Battery (push) Successful in 38m31s
v1.0.0-rc.187 (#98)
* Rugnux: Refinement several times faster, one protocol on the CPU and the GPU, parts of it on the Apple GPU; its random draws are the same on every platform.
* Rugnux: Refinement follows common practice: the free set decides only the restraint weights and the displacement model (isotropic, TLS or anisotropic, by Hamilton's test), everything else is decided on the working set; lower R-free for placed and predicted models.
* Rugnux: Restraint dictionaries via `--restraints` (or among the inputs) and more built-in ligands; a model whose space group is a subgroup of the data's is refined in its own group; reflections plus a model select `--mode refine` on their own.
* Rugnux: `-C` fixes the crystal system on the axes as typed; `-S` alone fixes the space group only, the cell is still found and reduced; a space group or cell stored in the input file is ignored, with a line in the log.
* Rugnux: More reliable multi-sweep merging; `--mode scale` merges several stills runs as one; `_plot.txt` and the report name each input; a second crystal form is reported for stills given a cell.
* jfjoch_broker (experimental): Live Rugnux on FPGA detectors (JUNGFRAU) takes the same path as a DECTRIS stream, rotation and serial alike, model step included, with analysis threads per GPU; frames waiting for the analysis can be viewed; no host stage drops a frame - a source faster than the analysis is held at the card.
* jfjoch_broker: Summation of more than 256 frames per image is split between the card and the host (`summation_mode` is then `hybrid`), and live Rugnux runs on such collections; pedestal runs take a receiver of their own.
* jfjoch_broker (experimental): `stills_downsample` analyses 1 of every N serial images (chosen by a hash; the first 2000 all; the others written without analysis; reset to 1 by `/initialize`); `max_spot_count` left out means 250 for per-image indexing and up to 1000 for live stills; the live status gives the merge before the model work, the fitted resolution and the anomalous peak height of each unexplained blob.
* jfjoch_broker: Without a `pcie` entry the broker runs on a mock of the card instead of the HLS simulation; its spot, ROI and azimuthal results are zero then.
* Web frontend: Redesigned Rugnux live page; Vite 8, TypeScript 6, Mol* 5.13 and dependency security updates.
* Tools: `jfjoch_fpga_stills_test` measures live stills on the cards with a stored dataset; `jfjoch_fpga_test` loses the HLS-simulation option.
* Other: FFTW no longer fetched or linked (the CPU FFT indexer keeps the name `FFTW`); PCIe driver now GPL-2.0-or-later and third-party notices complete; several crash fixes.

Reviewed-on: #98
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
2026-11-19 20:49:28 +01:00

65 lines
3.6 KiB
C++

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#pragma once
#include <cstddef>
#include <set>
#include <string>
#include <vector>
#include "gemmi/monlib.hpp"
// The restraint dictionary refinement uses: the subset of the CCP4 Monomer Library (Vagin et al. 2004,
// LGPL-3.0) carried in the binary - the standard amino acids and nucleotides, the common modified RNA nucleotides,
// their links and modifications, the common cofactors (NAD(P)(H), FAD, FMN, hemes, SAM/SAH), the chromophores of
// the common photoreceptors (retinal, p-coumaric acid, GFP-type, bilins), a few other ligands and additives, water
// and ions; monomers/update_monomers.py holds the list. Parsed from memory once per process;
// no file is read.
const gemmi::MonLib &EmbeddedMonomerLibrary();
// The ideal distance and its sigma of a bond from a metal ion to a donor atom (O, N, S) at a site of `coordination`
// donors, from the library's statistics of metal sites (metals.json, embedded as monomers/metals.cif). Only rows
// resting on at least METAL_MIN_SITES sites count: the row of that coordination number, else the two nearest
// below and above it interpolated linearly, else the nearest one; the sigma is the row's standard deviation, at
// least METAL_MIN_SIGMA. False where the pair has no such row.
constexpr int METAL_MIN_SITES = 20;
constexpr double METAL_MIN_SIGMA = 0.02; // A
bool EmbeddedMetalDistance(gemmi::El metal, gemmi::El ligand, int coordination, double &distance, double &sigma);
// Whether `code` (a residue name) has a description in it.
bool InEmbeddedMonomerLibrary(const std::string &code);
// A restraint dictionary given by the user (rugnux --restraints): monomers, links and modifications that the
// refinement takes over the embedded library's of the same name (BuildRefinementTopology). The caller reads it
// from its files (ReadRestraintDictionary); a later entry of the same name replaces an earlier one.
struct RestraintDictionary {
std::vector<gemmi::ChemComp> monomers;
std::vector<gemmi::ChemLink> links;
std::vector<gemmi::ChemMod> modifications;
std::set<std::string> from_coordinates; // the monomers whose restraints were made from their coordinates
std::vector<std::string> names; // of the texts read, as given to ReadRestraintDictionary
};
// Appends the contents of a restraint mmCIF to `dict`: a monomer-library, AceDRG or grade file (data_comp_list and
// data_comp_<CODE> blocks, data_link_list and data_link_<ID> blocks, data_mod_list ...), or an entry of the PDB
// Chemical Component Dictionary. A CCD entry carries no restraint values: its bonds, the angles at each atom with
// two or more bonds and a plane through each atom with a double or aromatic bond and its neighbours are restrained
// to the geometry of its ideal coordinates, at the sigmas below - no torsions and no chiral volumes. `name` labels
// the messages. Throws where the text holds no monomer, link or modification, or a CCD entry lacks an atom's ideal
// coordinates.
constexpr double DERIVED_BOND_SIGMA = 0.02; // A
constexpr double DERIVED_ANGLE_SIGMA = 3.0; // degrees
constexpr double DERIVED_PLANE_SIGMA = 0.02; // A
void ReadRestraintDictionary(const std::string &text, const std::string &name, RestraintDictionary &dict);
// The embedded library with `user` taken over it.
gemmi::MonLib MonomerLibraryWith(const RestraintDictionary &user);
// One .cif of monomers/, as CMakeLists.txt embeds it: its name and its text in pieces.
struct EmbeddedMonomerFile {
const char *name;
const char *const *pieces;
size_t n_pieces;
};