Skip to content

Commit

Permalink
Docs: add notes about optional dep groups
Browse files Browse the repository at this point in the history
  • Loading branch information
rkingsbury committed Jun 21, 2024
1 parent 29b03d3 commit 3ea3536
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/getting_started/running_builders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
17 changes: 17 additions & 0 deletions docs/reference/stores.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 3ea3536

Please sign in to comment.