Skip to content

Commit f32e9c1

Browse files
author
Jake Smith
committed
Merge branch 'main' of github.com:microsoft/MOFDiff into main
2 parents 9cda111 + 695d99d commit f32e9c1

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ If you find this code useful, please consider referencing our paper:
2424
- [Assemble all-atom MOFs](#assemble-all-atom-mofs)
2525
- [Relax MOFs](#relax-mofs-and-compute-structural-properties)
2626
- [GCMC simulations](#gcmc-simulation-for-gas-adsorption)
27+
- [Responsible AI FAQ](#responsible-ai-faq)
28+
- [Contributing](#contributing)
29+
- [Acknowledgement](#acknowledgement)
2730

2831
## Installation
2932

@@ -205,6 +208,29 @@ We have found that RASPA2 may occasionally have trouble reading input files as g
205208
python mofdiff/scripts/gcmc_screen.py --input ${sample_path}/mepo_qeq_charges --rewrite_raspa_input
206209
```
207210

211+
## Responsible AI FAQ
212+
213+
- What is MOFDiff?
214+
- MOFDiff is a deep neural network that models metal organic framework (MOF) 3D structures.
215+
- What can MOFDiff do?
216+
- MOFDiff allows you to train and sample from models that yield a coarse-grained representation of a MOF. It also includes functions for reassembly of an atomistic MOF structure from the coarse-grained representation and interaces to other molecular simulation software for evaluation of structural and gas separation properties.
217+
- What is/are MOFDiff’s intended use(s)?
218+
- MOFDiff is intended for research purposes only, for the machine learning for porous materials community.
219+
- How was MOFDiff evaluated? What metrics are used to measure performance?
220+
- MOFDiff was evaluated on the validity and novelty of the MOF structures sampled from MOFDiff. Additionally, structures optimized for CO2 adsorption were evaluated based on their simulated CO2 adsorption performance.
221+
- What are the limitations of MOFDiff? How can users minimize the impact of MOFDiff’s limitations when using the system?
222+
- MOFDiff has not been tested by real-world experiments to see if the MOF structures it samples are achievable. MOFDiff should be used for research purposes only.
223+
- What operational factors and settings allow for effective and responsible use of MOFDiff?
224+
- MOFDiff should be used for research purposes only.
225+
226+
## Contributing
227+
228+
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
229+
230+
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
231+
232+
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
233+
208234
## Acknowledgement
209235

210236
This codebase is based on several existing repositories:

0 commit comments

Comments
 (0)