search

materialsproject / fireworks

The Fireworks Workflow Management Repo.
https://materialsproject.github.io/fireworks
Other
361 stars 185 forks source link

Documentation suggestion: Explanation of uri_mode: true for a cloud-based MongoDB solution #484

Closed Andrew-S-Rosen closed 2 years ago

Andrew-S-Rosen commented 2 years ago

It took me a while to figure out that if I want to use a URI for a MongoDB, I need to set uri_mode: true in the my_launchpad.yaml file. This is a bit inconsistent with how atomate2/jobflow/maggma behave.

I think it would be worthwhile to add some information to the documentation about using the uri_mode: true flag when trying to access a cloud MongoDB system (e.g. MongoDB Atlas). The appropriate spot would be here.

The relevant code is below for context: https://github.com/materialsproject/fireworks/blob/2cc3b04f9071fe073efb5d9f5c154d95155ba4b5/fireworks/utilities/filepad.py#L73-L86

janosh commented 2 years ago

Related: The atomate docs could also use a bit more guidance for connecting to Atlas.