Skip to content

Fix JSONStore and add MemoryStore option in Installation Docs#1365

Merged
JaGeo merged 2 commits intomaterialsproject:mainfrom
thomasloux:fix/jsonstore-installation
Jan 2, 2026
Merged

Fix JSONStore and add MemoryStore option in Installation Docs#1365
JaGeo merged 2 commits intomaterialsproject:mainfrom
thomasloux:fix/jsonstore-installation

Conversation

@thomasloux
Copy link
Contributor

Summary

Fix the installation JSONStore (init requires paths and not uri). Also add MemoryStore in order to quickly test the installation as JSONStore does not work with all workflows (failing with PhononMaker with TypeError: Type is not JSON serializable: ScalarFloat).

Checklist

Work-in-progress pull requests are encouraged, but please put [WIP] in the pull request
title.

Before a pull request can be merged, the following items must be checked:

  • Code is in the standard Python style.
    The easiest way to handle this is to run the following in the correct sequence on
    your local machine. Start with running ruff and ruff format on your new code. This will
    automatically reformat your code to PEP8 conventions and fix many linting issues.
  • Doc strings have been added in the Numpy docstring format.
    Run ruff on your code.
  • Type annotations are highly encouraged. Run mypy to
    type check your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

Note that the CI system will run all the above checks. But it will be much more
efficient if you already fix most errors prior to submitting the PR. It is highly
recommended that you use the pre-commit hook provided in the repository. Simply run
pre-commit install and a check will be run prior to allowing commits.

@thomasloux thomasloux changed the title Fix JSONStore and add MemoryStore option Fix JSONStore and add MemoryStore option in Installation Docs Jan 2, 2026
@JaGeo
Copy link
Member

JaGeo commented Jan 2, 2026

@thomasloux Thank you! I kind of forgot that this is still part of the Installation instructions!

I think we should suggest the MemoryStore as a default. Actually, it should work without the setup as well.

Would you mind changing this as part of this PR?

@thomasloux
Copy link
Contributor Author

Indeed it works without setting anything (don't provide jobflow.yaml).

Do you want MemoryStore as default before MongoStore or just before JSONStore ?

@JaGeo
Copy link
Member

JaGeo commented Jan 2, 2026

@thomasloux just before JSONStore.

MongoStore is still the better option if you want to run high-throughput. We have been working on this as well to provide a different option.

@JaGeo JaGeo enabled auto-merge (squash) January 2, 2026 13:07
@JaGeo
Copy link
Member

JaGeo commented Jan 2, 2026

@thomasloux Thanks!

If you want to, you can add yourself to the list of contributors in your second PR!

@JaGeo JaGeo merged commit 717c320 into materialsproject:main Jan 2, 2026
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants