https://github.com/coudertlab/raess

Rapid Adsorption Enthalpy Surface Sampling

https://github.com/coudertlab/raess

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Rapid Adsorption Enthalpy Surface Sampling

Basic Info
  • Host: GitHub
  • Owner: coudertlab
  • License: mit
  • Language: C++
  • Default Branch: main
  • Size: 590 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

RAESS

RAESS (Rapid Adsorption Enthalpy Surface Sampling) is a sampling tool for rapid adsorption enthalpy and Henry constant calculations in nanoporous materials

Installation

Check if you have c++11 compiler installed (may work with other compiler but has been tested and mainly used with this compiler).

Tested for c++ (Ubuntu 9.4.0-1ubuntu1~20.04.1) 9.4.0

Compilation that follows the rules set in the Makefile: make all

Example Usage

If you want to run a surface sampling simulation on the structure KAXQIL (CSD code) from CoRE MOF 2019 all-solvent removed with the uff forcefield at 298K with a 12A cutoff for the xenon. ./raess structure/KAXQIL_clean_14.cif forcefield/UFF.def 298 12 2000 Xe 0.85 1.6 You should get an output that has values close to this: KAXQIL_clean_14,-44.4186,0.0283404,70.9159,0.0707517

The results are printed in a comma separated format: structure, adsorption enthalpy (kJ/mol), Henry coefficient (mol/kg/Pa), Accessible Surface Area (m2/cm3), Time (s)

This binary is supposed to be used in a high-throughput manner to add rows to a csv file.

Paper

This work is presented in the following article (please cite): “Rapid Adsorption Enthalpy Surface Sampling (RAESS) to Characterize Nanoporous Materials”, E. Ren and F.-X. Coudert, Chem. Sci., 2023, DOI: 10.1039/D2SC05810C

The current implementation is a bit faster than the one presented in the paper while remaining as accurate. (0.314 seconds computation time in average on the CoREMOF 2019 dataset with a LCD higher than 3.7 angstrom instead of 0.34 seconds in the paper).

Acknowledgement

This code has been developed during a PhD thesis co-financed by the CEA and Orano under the supervision of François-Xavier Coudert: https://github.com/fxcoudert

This code includes the library developed in Gemmi: https://github.com/project-gemmi/gemmi.git

License

The MIT License (MIT)

Copyright (c) 2022 Emmanuel Ren

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 0
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels