From 29b03d35a9eaca57369d64d1bd1ea8bc4c2cc0f2 Mon Sep 17 00:00:00 2001 From: Ryan Date: Fri, 21 Jun 2024 12:57:44 -0400 Subject: [PATCH 1/2] pin numpy<2 --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 45c6533c6..d9baeecac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -37,7 +37,7 @@ dependencies = [ "pandas>=2.2", "jsonlines>=4.0.0", "aioitertools>=0.5.1", - "numpy>=1.17.3", + "numpy>=1.17.3, <2", "pyzmq>=24.0.1", "dnspython>=1.16.0", "sshtunnel>=0.1.5", From 3ea353665d4964bc337f583819384dad0c4ea1b3 Mon Sep 17 00:00:00 2001 From: Ryan Date: Fri, 21 Jun 2024 12:58:01 -0400 Subject: [PATCH 2/2] Docs: add notes about optional dep groups --- docs/getting_started/running_builders.md | 2 +- docs/reference/stores.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/running_builders.md b/docs/getting_started/running_builders.md index 1483ff4e2..5c120eb19 100644 --- a/docs/getting_started/running_builders.md +++ b/docs/getting_started/running_builders.md @@ -123,7 +123,7 @@ These event docs also contain the `builder`, a `build_id` which is unique for ea ## Profiling Memory Usage of Builders -`mrun` can optionally profile the memory usage of a running builder by using the Memray Python memory profiling tool ([Memray](https://github.com/bloomberg/memray)). To get started, Memray should be installed in the same environment as `maggma` using `pip install memray`. +`mrun` can optionally profile the memory usage of a running builder by using the Memray Python memory profiling tool ([Memray](https://github.com/bloomberg/memray)). To get started, Memray should be installed in the same environment as `maggma` using `pip install memray` (r `pip install maggma[memray]`). Setting the `--memray` (`-m`) option to `on`, or `True`, will signal `mrun` to profile the memory usage of any builders passed to `mrun` as the builders are running. The profiler also supports profiling of both single and forked processes. For example, spawning multiple processes in `mrun` with `-n` will signal the profiler to track any forked child processes spawned from the parent process. diff --git a/docs/reference/stores.md b/docs/reference/stores.md index 2f94909e5..f9b757275 100644 --- a/docs/reference/stores.md +++ b/docs/reference/stores.md @@ -1,3 +1,20 @@ +!!! note + Some `Store` classes require extra packages that are not installed by default. Run the following modified installation commands if you want + to use these stores: + + `MongograntStore`: + ```shell + pip install maggma[mongogrant] + ``` + `MontyStore`: + ```shell + pip install maggma[montydb] + ``` + `VaultStore`: + ```shell + pip install maggma[vault] + ``` + ::: maggma.stores.mongolike ::: maggma.stores.file_store